FHIRPath
LOG IN
SIGN UP
If you
Log in
or
sign up
, you can edit this script yourself.
{ "entry": [ { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/ServiceRequestOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ServiceRequest", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR ServiceRequest Profile, for OH interoperability scenarios, based on the national CORE ServiceRequest Profile defined by HL7 OH.", "differential": { "element": [ { "id": "ServiceRequest.identifier", "max": "1", "min": 1, "path": "ServiceRequest.identifier" }, { "definition": "The purpose of this identifier. [ES: Valor por defecto \"official\"]", "id": "ServiceRequest.identifier.use", "min": 1, "path": "ServiceRequest.identifier.use", "patternCode": "official", "short": "The purpose of this identifier. [ES: Valor por defecto \"official\"]" }, { "id": "ServiceRequest.identifier.type", "max": "0", "path": "ServiceRequest.identifier.type" }, { "id": "ServiceRequest.identifier.system", "min": 1, "path": "ServiceRequest.identifier.system" }, { "id": "ServiceRequest.identifier.value", "min": 1, "path": "ServiceRequest.identifier.value" }, { "id": "ServiceRequest.identifier.period", "max": "0", "path": "ServiceRequest.identifier.period" }, { "id": "ServiceRequest.identifier.assigner", "min": 1, "path": "ServiceRequest.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "ServiceRequest.instantiatesCanonical", "max": "0", "path": "ServiceRequest.instantiatesCanonical" }, { "id": "ServiceRequest.instantiatesUri", "max": "0", "path": "ServiceRequest.instantiatesUri" }, { "id": "ServiceRequest.basedOn", "max": "0", "path": "ServiceRequest.basedOn" }, { "id": "ServiceRequest.replaces", "max": "0", "path": "ServiceRequest.replaces" }, { "id": "ServiceRequest.requisition", "max": "0", "path": "ServiceRequest.requisition" }, { "definition": "The status of the order. [ES: Ej: Cuando el profesional crea la orden: \"active\". Cuando llega el resultado: \"completed\". ]", "id": "ServiceRequest.status", "path": "ServiceRequest.status", "short": "The status of the order. [ES: Ej: Cuando el profesional crea la orden: \"active\". Cuando llega el resultado: \"completed\". ]" }, { "definition": "Whether the request is a proposal, plan, an original order or a reflex order. [ES: Valor por defecto \"order\"]", "id": "ServiceRequest.intent", "path": "ServiceRequest.intent", "patternCode": "order", "short": "Whether the request is a proposal, plan, an original order or a reflex order. [ES: Valor por defecto \"order\"]" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/servicerequest-category" }, "id": "ServiceRequest.category", "max": "1", "path": "ServiceRequest.category" }, { "id": "ServiceRequest.category.coding.system", "min": 1, "path": "ServiceRequest.category.coding.system" }, { "id": "ServiceRequest.category.coding.version", "max": "0", "path": "ServiceRequest.category.coding.version" }, { "id": "ServiceRequest.category.coding.code", "min": 1, "path": "ServiceRequest.category.coding.code" }, { "id": "ServiceRequest.category.coding.display", "min": 1, "path": "ServiceRequest.category.coding.display" }, { "id": "ServiceRequest.category.coding.userSelected", "max": "0", "path": "ServiceRequest.category.coding.userSelected" }, { "id": "ServiceRequest.category.text", "max": "0", "path": "ServiceRequest.category.text" }, { "id": "ServiceRequest.doNotPerform", "max": "0", "path": "ServiceRequest.doNotPerform" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/procedure-code" }, "id": "ServiceRequest.code", "min": 1, "path": "ServiceRequest.code" }, { "id": "ServiceRequest.code.coding.system", "min": 1, "path": "ServiceRequest.code.coding.system" }, { "id": "ServiceRequest.code.coding.version", "max": "0", "path": "ServiceRequest.code.coding.version" }, { "id": "ServiceRequest.code.coding.code", "min": 1, "path": "ServiceRequest.code.coding.code" }, { "id": "ServiceRequest.code.coding.display", "min": 1, "path": "ServiceRequest.code.coding.display" }, { "id": "ServiceRequest.code.coding.userSelected", "max": "0", "path": "ServiceRequest.code.coding.userSelected" }, { "id": "ServiceRequest.code.text", "max": "0", "path": "ServiceRequest.code.text" }, { "id": "ServiceRequest.orderDetail", "max": "0", "path": "ServiceRequest.orderDetail" }, { "id": "ServiceRequest.quantity[x]", "path": "ServiceRequest.quantity[x]", "type": [ { "code": "Quantity" } ] }, { "id": "ServiceRequest.subject", "path": "ServiceRequest.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "ServiceRequest.encounter", "path": "ServiceRequest.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "id": "ServiceRequest.occurrence[x]", "path": "ServiceRequest.occurrence[x]", "type": [ { "code": "dateTime" } ] }, { "id": "ServiceRequest.asNeeded[x]", "max": "0", "path": "ServiceRequest.asNeeded[x]" }, { "id": "ServiceRequest.authoredOn", "min": 1, "path": "ServiceRequest.authoredOn" }, { "id": "ServiceRequest.requester", "min": 1, "path": "ServiceRequest.requester", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "ServiceRequest.performerType", "max": "0", "path": "ServiceRequest.performerType" }, { "id": "ServiceRequest.performer", "max": "0", "path": "ServiceRequest.performer" }, { "id": "ServiceRequest.locationCode", "max": "0", "path": "ServiceRequest.locationCode" }, { "id": "ServiceRequest.locationReference", "max": "0", "path": "ServiceRequest.locationReference" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/procedure-reason" }, "id": "ServiceRequest.reasonCode", "path": "ServiceRequest.reasonCode" }, { "id": "ServiceRequest.reasonCode.coding.system", "min": 1, "path": "ServiceRequest.reasonCode.coding.system" }, { "id": "ServiceRequest.reasonCode.coding.version", "max": "0", "path": "ServiceRequest.reasonCode.coding.version" }, { "id": "ServiceRequest.reasonCode.coding.code", "min": 1, "path": "ServiceRequest.reasonCode.coding.code" }, { "id": "ServiceRequest.reasonCode.coding.display", "min": 1, "path": "ServiceRequest.reasonCode.coding.display" }, { "id": "ServiceRequest.reasonCode.coding.userSelected", "max": "0", "path": "ServiceRequest.reasonCode.coding.userSelected" }, { "id": "ServiceRequest.reasonCode.text", "max": "0", "path": "ServiceRequest.reasonCode.text" }, { "id": "ServiceRequest.reasonReference", "path": "ServiceRequest.reasonReference", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH", "https://fhir.onehealth.com.pe/StructureDefinition/ConditionProblemListItemOH" ] } ] }, { "id": "ServiceRequest.insurance", "max": "1", "path": "ServiceRequest.insurance", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/CoverageOH" ] } ] }, { "id": "ServiceRequest.supportingInfo", "max": "0", "path": "ServiceRequest.supportingInfo" }, { "id": "ServiceRequest.specimen", "max": "0", "path": "ServiceRequest.specimen" }, { "id": "ServiceRequest.bodySite", "max": "0", "path": "ServiceRequest.bodySite" }, { "id": "ServiceRequest.relevantHistory", "max": "0", "path": "ServiceRequest.relevantHistory" } ] }, "fhirVersion": "4.0.1", "id": "ServiceRequestOH", "jurisdiction": [ { "coding": [ { "code": "PER", "display": "Perú", "system": "urn:iso:std:iso:3166" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "quick", "name": "Quality Improvement and Clinical Knowledge (QUICK)", "uri": "http://siframework.org/cqf" } ], "meta": { "lastUpdated": "2024-04-12T17:46:28.094614+00:00", "versionId": "MTcxMjk0Mzk4ODA5NDYxNDAwMA" }, "name": "ServiceRequestOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "diagnostic request", "referral", "referral request", "transfer of care request" ], "base": { "max": "*", "min": 0, "path": "ServiceRequest" }, "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "orderDetail.empty() or code.exists()", "human": "orderDetail SHALL only be present if code is present", "key": "prr-1", "severity": "error", "xpath": "exists(f:code) or not(exists(f:orderDetail))" } ], "definition": "A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.", "id": "ServiceRequest", "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]" } ], "max": "*", "min": 0, "path": "ServiceRequest", "short": "A request for a service to be performed" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "ServiceRequest.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "ServiceRequest.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "ServiceRequest.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "ServiceRequest.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "ServiceRequest.implicitRules", "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, "max": "1", "min": 0, "path": "ServiceRequest.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "ServiceRequest.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "ServiceRequest.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "ServiceRequest.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "ServiceRequest.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "ServiceRequest.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "ServiceRequest.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "ServiceRequest.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "ServiceRequest.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "ServiceRequest.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "ServiceRequest.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "ServiceRequest.identifier" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.", "id": "ServiceRequest.identifier", "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" } ], "max": "1", "min": 1, "path": "ServiceRequest.identifier", "short": "Identifiers assigned to this order", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "ServiceRequest.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "ServiceRequest.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "ServiceRequest.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "ServiceRequest.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier. [ES: Valor por defecto \"official\"]", "id": "ServiceRequest.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "ServiceRequest.identifier.use", "patternCode": "official", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "The purpose of this identifier. [ES: Valor por defecto \"official\"]", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "ServiceRequest.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "ServiceRequest.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "ServiceRequest.identifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 1, "path": "ServiceRequest.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "example": [ { "label": "General", "valueString": "123456" } ], "id": "ServiceRequest.identifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "ServiceRequest.identifier.value", "short": "The value that is unique", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "ServiceRequest.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "ServiceRequest.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "ServiceRequest.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 1, "path": "ServiceRequest.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "ServiceRequest.instantiatesCanonical" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "ServiceRequest.instantiatesCanonical", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.instantiatesCanonical" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ], "max": "0", "min": 0, "path": "ServiceRequest.instantiatesCanonical", "short": "Instantiates FHIR protocol or definition", "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/PlanDefinition" ] } ] }, { "base": { "max": "*", "min": 0, "path": "ServiceRequest.instantiatesUri" }, "comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "ServiceRequest.instantiatesUri", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.instantiatesUri" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ], "max": "0", "min": 0, "path": "ServiceRequest.instantiatesUri", "short": "Instantiates external protocol or definition", "type": [ { "code": "uri" } ] }, { "alias": [ "fulfills" ], "base": { "max": "*", "min": 0, "path": "ServiceRequest.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Plan/proposal/order fulfilled by this request.", "id": "ServiceRequest.basedOn", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.basedOn" }, { "identity": "v2", "map": "ORC.8 (plus others)" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target" } ], "max": "0", "min": 0, "path": "ServiceRequest.basedOn", "short": "What request fulfills", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/ServiceRequest", "http://hl7.org/fhir/StructureDefinition/MedicationRequest" ] } ] }, { "alias": [ "supersedes", "prior", "renewed order" ], "base": { "max": "*", "min": 0, "path": "ServiceRequest.replaces" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The request takes the place of the referenced completed or terminated request(s).", "id": "ServiceRequest.replaces", "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" } ], "max": "0", "min": 0, "path": "ServiceRequest.replaces", "short": "What request replaces", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ServiceRequest" ] } ] }, { "alias": [ "grouperId", "groupIdentifier" ], "base": { "max": "1", "min": 0, "path": "ServiceRequest.requisition" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "ServiceRequest.requisition", "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" } ], "max": "0", "min": 0, "path": "ServiceRequest.requisition", "requirements": "Some business processes need to know if multiple items were ordered as part of the same \"requisition\" for billing or other purposes.", "short": "Composite Request ID", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 1, "path": "ServiceRequest.status" }, "binding": { "description": "The status of a service order.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ServiceRequestStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-status|4.0.1" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status of the order. [ES: Ej: Cuando el profesional crea la orden: \"active\". Cuando llega el resultado: \"completed\". ]", "id": "ServiceRequest.status", "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, "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" } ], "max": "1", "min": 1, "path": "ServiceRequest.status", "short": "The status of the order. [ES: Ej: Cuando el profesional crea la orden: \"active\". Cuando llega el resultado: \"completed\". ]", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "ServiceRequest.intent" }, "binding": { "description": "The kind of service request.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ServiceRequestIntent" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-intent|4.0.1" }, "comment": "This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Whether the request is a proposal, plan, an original order or a reflex order. [ES: Valor por defecto \"order\"]", "id": "ServiceRequest.intent", "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, "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)" } ], "max": "1", "min": 1, "path": "ServiceRequest.intent", "patternCode": "order", "short": "Whether the request is a proposal, plan, an original order or a reflex order. [ES: Valor por defecto \"order\"]", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "ServiceRequest.category" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/servicerequest-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the service for searching, sorting and display purposes (e.g. \"Surgical Procedure\").", "id": "ServiceRequest.category", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "v2", "map": "RF1-5" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"INT\"].code" } ], "max": "1", "min": 0, "path": "ServiceRequest.category", "requirements": "Used for filtering what service request are retrieved and displayed.", "short": "Classification of service", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "ServiceRequest.category.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "ServiceRequest.category.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "ServiceRequest.category.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "ServiceRequest.category.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "ServiceRequest.category.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "ServiceRequest.category.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "ServiceRequest.category.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "ServiceRequest.category.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "ServiceRequest.category.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "ServiceRequest.category.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "ServiceRequest.category.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "ServiceRequest.category.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "ServiceRequest.category.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "ServiceRequest.category.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "ServiceRequest.category.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "ServiceRequest.category.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "ServiceRequest.category.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "ServiceRequest.category.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "ServiceRequest.category.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "ServiceRequest.category.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "ServiceRequest.category.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "ServiceRequest.category.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "ServiceRequest.priority" }, "binding": { "description": "Identifies the level of importance to be assigned to actioning the request.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ServiceRequestPriority" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-priority|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates how quickly the ServiceRequest should be addressed with respect to other requests.", "id": "ServiceRequest.priority", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.priority" }, { "identity": "w5", "map": "FiveWs.grade" }, { "identity": "v2", "map": "TQ1.9, RF1-2" }, { "identity": "rim", "map": ".priorityCode" } ], "max": "1", "meaningWhenMissing": "If missing, this task should be performed with normal priority", "min": 0, "path": "ServiceRequest.priority", "short": "routine | urgent | asap | stat", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "ServiceRequest.doNotPerform" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Set this to true if the record is saying that the service/procedure should NOT be performed.", "id": "ServiceRequest.doNotPerform", "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" } ], "max": "0", "meaningWhenMissing": "If missing, the request is a positive request e.g. \"do perform\"", "min": 0, "path": "ServiceRequest.doNotPerform", "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.", "short": "True if service/procedure should not be performed", "type": [ { "code": "boolean" } ] }, { "alias": [ "service requested" ], "base": { "max": "1", "min": 0, "path": "ServiceRequest.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/procedure-code" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.", "id": "ServiceRequest.code", "isModifier": false, "isSummary": true, "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" } ], "max": "1", "min": 1, "path": "ServiceRequest.code", "short": "What is being requested/ordered", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "ServiceRequest.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "ServiceRequest.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "ServiceRequest.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "ServiceRequest.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "ServiceRequest.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "ServiceRequest.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "ServiceRequest.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "ServiceRequest.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "ServiceRequest.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "ServiceRequest.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "ServiceRequest.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "ServiceRequest.code.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "ServiceRequest.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "ServiceRequest.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "ServiceRequest.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "ServiceRequest.code.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "ServiceRequest.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "ServiceRequest.code.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "ServiceRequest.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "ServiceRequest.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "ServiceRequest.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "ServiceRequest.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "detailed instructions" ], "base": { "max": "*", "min": 0, "path": "ServiceRequest.orderDetail" }, "binding": { "description": "Codified order entry details which are based on order context.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "OrderDetail" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/servicerequest-orderdetail" }, "comment": "For information from the medical record intended to support the delivery of the requested services, use the `supportingInformation` element.", "condition": [ "prr-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "ServiceRequest.orderDetail", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "NTE" }, { "identity": "rim", "map": ".code" }, { "identity": "quick", "map": "Procedure.procedureCode" } ], "max": "0", "min": 0, "path": "ServiceRequest.orderDetail", "short": "Additional order information", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "ServiceRequest.quantity[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "ServiceRequest.quantity[x]", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "NTE" }, { "identity": "rim", "map": ".quantity" } ], "max": "1", "min": 0, "path": "ServiceRequest.quantity[x]", "requirements": "When ordering a service the number of service items may need to be specified separately from the the service item.", "short": "Service amount", "type": [ { "code": "Quantity" } ] }, { "base": { "max": "1", "min": 1, "path": "ServiceRequest.subject" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "ServiceRequest.subject", "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" } ], "max": "1", "min": 1, "path": "ServiceRequest.subject", "short": "Individual or Entity the service is ordered for", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "alias": [ "context" ], "base": { "max": "1", "min": 0, "path": "ServiceRequest.encounter" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An encounter that provides additional information about the healthcare context in which this request is made.", "id": "ServiceRequest.encounter", "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" } ], "max": "1", "min": 0, "path": "ServiceRequest.encounter", "short": "Encounter in which the request was created", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "alias": [ "schedule" ], "base": { "max": "1", "min": 0, "path": "ServiceRequest.occurrence[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time at which the requested service should occur.", "id": "ServiceRequest.occurrence[x]", "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" } ], "max": "1", "min": 0, "path": "ServiceRequest.occurrence[x]", "short": "When service should occur", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "ServiceRequest.asNeeded[x]" }, "binding": { "description": "A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example \"pain\", \"on flare-up\", etc.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureAsNeededReason" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/medication-as-needed-reason" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example \"pain\", \"on flare-up\", etc.", "id": "ServiceRequest.asNeeded[x]", "isModifier": false, "isSummary": true, "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" } ], "max": "0", "min": 0, "path": "ServiceRequest.asNeeded[x]", "short": "Preconditions for service", "type": [ { "code": "boolean" }, { "code": "CodeableConcept" } ] }, { "alias": [ "orderedOn" ], "base": { "max": "1", "min": 0, "path": "ServiceRequest.authoredOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When the request transitioned to being actionable.", "id": "ServiceRequest.authoredOn", "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" } ], "max": "1", "min": 1, "path": "ServiceRequest.authoredOn", "short": "Date request signed", "type": [ { "code": "dateTime" } ] }, { "alias": [ "author", "orderer" ], "base": { "max": "1", "min": 0, "path": "ServiceRequest.requester" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The individual who initiated the request and has responsibility for its activation.", "id": "ServiceRequest.requester", "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" } ], "max": "1", "min": 1, "path": "ServiceRequest.requester", "short": "Who/what is requesting service", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "alias": [ "specialty" ], "base": { "max": "1", "min": 0, "path": "ServiceRequest.performerType" }, "binding": { "description": "Indicates specific responsibility of an individual within the care team, such as \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ServiceRequestParticipantRole" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/participant-role" }, "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”.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Desired type of performer for doing the requested service.", "id": "ServiceRequest.performerType", "isModifier": false, "isSummary": true, "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" } ], "max": "0", "min": 0, "path": "ServiceRequest.performerType", "short": "Performer role", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "request recipient" ], "base": { "max": "*", "min": 0, "path": "ServiceRequest.performer" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.", "id": "ServiceRequest.performer", "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]" } ], "max": "0", "min": 0, "path": "ServiceRequest.performer", "short": "Requested performer", "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" ] } ] }, { "base": { "max": "*", "min": 0, "path": "ServiceRequest.locationCode" }, "binding": { "description": "A location type where services are delivered.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ServiceRequestLocation" } ], "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "ServiceRequest.locationCode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "rim", "map": ".participation[typeCode=LOC].role[scoper.determinerCode=KIND].code" } ], "max": "0", "min": 0, "path": "ServiceRequest.locationCode", "short": "Requested location", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "ServiceRequest.locationReference" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.", "id": "ServiceRequest.locationReference", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "rim", "map": ".participation[typeCode=LOC].role[scoper.determinerCode=INSTANCE]" } ], "max": "0", "min": 0, "path": "ServiceRequest.locationReference", "short": "Requested location", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ] } ] }, { "base": { "max": "*", "min": 0, "path": "ServiceRequest.reasonCode" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/procedure-reason" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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`.", "id": "ServiceRequest.reasonCode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.reasonCode" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "v2", "map": "ORC.16, RF1-10" }, { "identity": "rim", "map": ".reasonCode" } ], "max": "*", "min": 0, "path": "ServiceRequest.reasonCode", "short": "Explanation/Justification for procedure or service", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "ServiceRequest.reasonCode.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "ServiceRequest.reasonCode.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "ServiceRequest.reasonCode.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "ServiceRequest.reasonCode.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "ServiceRequest.reasonCode.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "ServiceRequest.reasonCode.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "ServiceRequest.reasonCode.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "ServiceRequest.reasonCode.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "ServiceRequest.reasonCode.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "ServiceRequest.reasonCode.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "ServiceRequest.reasonCode.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "ServiceRequest.reasonCode.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "ServiceRequest.reasonCode.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "ServiceRequest.reasonCode.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "ServiceRequest.reasonCode.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "ServiceRequest.reasonCode.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "ServiceRequest.reasonCode.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "ServiceRequest.reasonCode.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "ServiceRequest.reasonCode.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "ServiceRequest.reasonCode.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "ServiceRequest.reasonCode.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "ServiceRequest.reasonCode.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "ServiceRequest.reasonReference" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.", "id": "ServiceRequest.reasonReference", "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" } ], "max": "*", "min": 0, "path": "ServiceRequest.reasonReference", "short": "Explanation/Justification for service or service", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH", "https://fhir.onehealth.com.pe/StructureDefinition/ConditionProblemListItemOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "ServiceRequest.insurance" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.", "id": "ServiceRequest.insurance", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.insurance" }, { "identity": "v2", "map": "IN1/IN2" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COVBY].target" } ], "max": "1", "min": 0, "path": "ServiceRequest.insurance", "short": "Associated insurance coverage", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/CoverageOH" ] } ] }, { "alias": [ "Ask at order entry question", "AOE" ], "base": { "max": "*", "min": 0, "path": "ServiceRequest.supportingInfo" }, "comment": "To represent information about how the services are to be delivered use the `instructions` element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "ServiceRequest.supportingInfo", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.supportingInfo" }, { "identity": "v2", "map": "Accompanying segments" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=PERT].target" } ], "max": "0", "min": 0, "path": "ServiceRequest.supportingInfo", "short": "Additional clinical information", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "*", "min": 0, "path": "ServiceRequest.specimen" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "One or more specimens that the laboratory procedure will use.", "id": "ServiceRequest.specimen", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "SPM" }, { "identity": "rim", "map": ".participation[typeCode=SPC].role" } ], "max": "0", "min": 0, "path": "ServiceRequest.specimen", "short": "Procedure Samples", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ] }, { "alias": [ "location" ], "base": { "max": "*", "min": 0, "path": "ServiceRequest.bodySite" }, "binding": { "description": "Codes describing anatomical locations. May include laterality.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Anatomic location where the procedure should be performed. This is the target site.", "id": "ServiceRequest.bodySite", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "SPM" }, { "identity": "rim", "map": "targetSiteCode" }, { "identity": "quick", "map": "Procedure.targetBodySite" } ], "max": "0", "min": 0, "path": "ServiceRequest.bodySite", "requirements": "Knowing where the procedure is performed is important for tracking if multiple sites are possible.", "short": "Location on Body", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "ServiceRequest.note" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Any other notes and comments made about the service request. For example, internal billing notes.", "id": "ServiceRequest.note", "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" } ], "max": "*", "min": 0, "path": "ServiceRequest.note", "short": "Comments", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "1", "min": 0, "path": "ServiceRequest.patientInstruction" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instructions in terms that are understood by the patient or consumer.", "id": "ServiceRequest.patientInstruction", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "NTE" }, { "identity": "rim", "map": ".text" } ], "max": "1", "min": 0, "path": "ServiceRequest.patientInstruction", "short": "Patient or consumer-oriented instructions", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "ServiceRequest.relevantHistory" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Key events in the history of the request.", "id": "ServiceRequest.relevantHistory", "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]" } ], "max": "0", "min": 0, "path": "ServiceRequest.relevantHistory", "short": "Request provenance", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Provenance" ] } ] } ] }, "status": "draft", "title": "OneHealth ServiceRequest", "type": "ServiceRequest", "url": "https://fhir.onehealth.com.pe/StructureDefinition/ServiceRequestOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/RequestGroupOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/RequestGroup", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-02-01", "derivation": "constraint", "description": "FHIR RequestGroupOH Profile, for OH interoperability scenarios, based on the national CORE RequestGroup Profile defined by HL7 OH.", "differential": { "element": [ { "id": "RequestGroup.identifier", "max": "0", "path": "RequestGroup.identifier" }, { "id": "RequestGroup.instantiatesCanonical", "max": "0", "path": "RequestGroup.instantiatesCanonical" }, { "id": "RequestGroup.instantiatesUri", "max": "0", "path": "RequestGroup.instantiatesUri" }, { "id": "RequestGroup.basedOn", "max": "0", "path": "RequestGroup.basedOn" }, { "id": "RequestGroup.replaces", "max": "0", "path": "RequestGroup.replaces" }, { "id": "RequestGroup.groupIdentifier", "min": 1, "path": "RequestGroup.groupIdentifier" }, { "definition": "The purpose of this identifier. [ES: Valor por defecto \"official\"]", "id": "RequestGroup.groupIdentifier.use", "min": 1, "path": "RequestGroup.groupIdentifier.use", "patternCode": "official", "short": "The purpose of this identifier. [ES: Valor por defecto \"official\"]" }, { "id": "RequestGroup.groupIdentifier.type", "max": "0", "path": "RequestGroup.groupIdentifier.type" }, { "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique. [ES: ES: Debe indicarse en este campo el sistema del cual proviene la orden (Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)]", "id": "RequestGroup.groupIdentifier.system", "min": 1, "path": "RequestGroup.groupIdentifier.system", "short": "The namespace for the identifier value. [ES: Debe indicarse en este campo el sistema del cual proviene la orden (Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)]" }, { "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: Número de orden de medicamentos o número de receta]", "id": "RequestGroup.groupIdentifier.value", "min": 1, "path": "RequestGroup.groupIdentifier.value", "short": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: Número de orden de medicamentos o número de receta]" }, { "id": "RequestGroup.groupIdentifier.period", "max": "0", "path": "RequestGroup.groupIdentifier.period" }, { "id": "RequestGroup.groupIdentifier.assigner", "min": 1, "path": "RequestGroup.groupIdentifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "definition": "Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. [ES: Valor por defecto \"order\"]", "id": "RequestGroup.intent", "path": "RequestGroup.intent", "patternCode": "order", "short": "Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. [ES: Valor por defecto \"order\"]" }, { "id": "RequestGroup.code", "max": "0", "path": "RequestGroup.code" }, { "id": "RequestGroup.subject", "min": 1, "path": "RequestGroup.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "RequestGroup.encounter", "min": 1, "path": "RequestGroup.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "id": "RequestGroup.authoredOn", "max": "0", "path": "RequestGroup.authoredOn" }, { "id": "RequestGroup.author", "max": "0", "path": "RequestGroup.author" }, { "id": "RequestGroup.reasonCode", "max": "0", "path": "RequestGroup.reasonCode" }, { "id": "RequestGroup.reasonReference", "max": "0", "path": "RequestGroup.reasonReference" }, { "id": "RequestGroup.note", "max": "0", "path": "RequestGroup.note" }, { "id": "RequestGroup.action", "min": 1, "path": "RequestGroup.action" }, { "id": "RequestGroup.action.prefix", "max": "0", "path": "RequestGroup.action.prefix" }, { "id": "RequestGroup.action.title", "max": "0", "path": "RequestGroup.action.title" }, { "id": "RequestGroup.action.description", "max": "0", "path": "RequestGroup.action.description" }, { "id": "RequestGroup.action.textEquivalent", "max": "0", "path": "RequestGroup.action.textEquivalent" }, { "id": "RequestGroup.action.priority", "max": "0", "path": "RequestGroup.action.priority" }, { "id": "RequestGroup.action.code", "max": "0", "path": "RequestGroup.action.code" }, { "id": "RequestGroup.action.documentation", "max": "0", "path": "RequestGroup.action.documentation" }, { "id": "RequestGroup.action.condition", "max": "0", "path": "RequestGroup.action.condition" }, { "id": "RequestGroup.action.relatedAction", "max": "0", "path": "RequestGroup.action.relatedAction" }, { "id": "RequestGroup.action.timing[x]", "max": "0", "path": "RequestGroup.action.timing[x]" }, { "id": "RequestGroup.action.participant", "max": "0", "path": "RequestGroup.action.participant" }, { "id": "RequestGroup.action.type", "max": "0", "path": "RequestGroup.action.type" }, { "id": "RequestGroup.action.groupingBehavior", "max": "0", "path": "RequestGroup.action.groupingBehavior" }, { "id": "RequestGroup.action.selectionBehavior", "max": "0", "path": "RequestGroup.action.selectionBehavior" }, { "id": "RequestGroup.action.requiredBehavior", "max": "0", "path": "RequestGroup.action.requiredBehavior" }, { "id": "RequestGroup.action.precheckBehavior", "max": "0", "path": "RequestGroup.action.precheckBehavior" }, { "id": "RequestGroup.action.cardinalityBehavior", "max": "0", "path": "RequestGroup.action.cardinalityBehavior" }, { "definition": "The resource that is the target of the action (e.g. CommunicationRequest). [ES: Se hace referencia a cada uno de los MedicationRequest que componen la receta u orden de medicamentos]", "id": "RequestGroup.action.resource", "min": 1, "path": "RequestGroup.action.resource", "short": "The resource that is the target of the action (e.g. CommunicationRequest). [ES: Se hace referencia a cada uno de los MedicationRequest que componen la receta u orden de medicamentos]", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/MedicationRequestOH" ] } ] }, { "id": "RequestGroup.action.action", "max": "0", "path": "RequestGroup.action.action" } ] }, "fhirVersion": "4.0.1", "id": "RequestGroupOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" } ], "meta": { "lastUpdated": "2024-04-12T17:46:27.866887+00:00", "versionId": "MTcxMjk0Mzk4Nzg2Njg4NzAwMA" }, "name": "RequestGroupOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "RequestGroup" }, "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "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\".", "id": "RequestGroup", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Request" } ], "max": "*", "min": 0, "path": "RequestGroup", "short": "A group of related requests" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "RequestGroup.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "RequestGroup.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "RequestGroup.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "RequestGroup.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "RequestGroup.implicitRules", "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, "max": "1", "min": 0, "path": "RequestGroup.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "RequestGroup.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "RequestGroup.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "RequestGroup.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "RequestGroup.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "RequestGroup.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "RequestGroup.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "RequestGroup.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "RequestGroup.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "RequestGroup.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "RequestGroup.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "RequestGroup.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Allows a service to provide a unique, business identifier for the request.", "id": "RequestGroup.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" } ], "max": "0", "min": 0, "path": "RequestGroup.identifier", "requirements": "Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.", "short": "Business identifier", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "*", "min": 0, "path": "RequestGroup.instantiatesCanonical" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "RequestGroup.instantiatesCanonical", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.instantiatesCanonical" } ], "max": "0", "min": 0, "path": "RequestGroup.instantiatesCanonical", "short": "Instantiates FHIR protocol or definition", "type": [ { "code": "canonical" } ] }, { "base": { "max": "*", "min": 0, "path": "RequestGroup.instantiatesUri" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "RequestGroup.instantiatesUri", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.instantiatesUri" } ], "max": "0", "min": 0, "path": "RequestGroup.instantiatesUri", "short": "Instantiates external protocol or definition", "type": [ { "code": "uri" } ] }, { "alias": [ "fulfills" ], "base": { "max": "*", "min": 0, "path": "RequestGroup.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A plan, proposal or order that is fulfilled in whole or in part by this request.", "id": "RequestGroup.basedOn", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.basedOn" } ], "max": "0", "min": 0, "path": "RequestGroup.basedOn", "requirements": "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.", "short": "Fulfills plan, proposal, or order", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "alias": [ "supersedes", "prior", "renewed order" ], "base": { "max": "*", "min": 0, "path": "RequestGroup.replaces" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Completed or terminated request(s) whose function is taken by this new request.", "id": "RequestGroup.replaces", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.replaces" } ], "max": "0", "min": 0, "path": "RequestGroup.replaces", "requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.", "short": "Request(s) replaced by this request", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "alias": [ "grouperid", "requisition" ], "base": { "max": "1", "min": 0, "path": "RequestGroup.groupIdentifier" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "RequestGroup.groupIdentifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.groupIdentifier" } ], "max": "1", "min": 1, "path": "RequestGroup.groupIdentifier", "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.", "short": "Composite request this is part of", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "RequestGroup.groupIdentifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "RequestGroup.groupIdentifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "RequestGroup.groupIdentifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "RequestGroup.groupIdentifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier. [ES: Valor por defecto \"official\"]", "id": "RequestGroup.groupIdentifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "RequestGroup.groupIdentifier.use", "patternCode": "official", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "The purpose of this identifier. [ES: Valor por defecto \"official\"]", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "RequestGroup.groupIdentifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "RequestGroup.groupIdentifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique. [ES: ES: Debe indicarse en este campo el sistema del cual proviene la orden (Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)]", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "RequestGroup.groupIdentifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 1, "path": "RequestGroup.groupIdentifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value. [ES: Debe indicarse en este campo el sistema del cual proviene la orden (Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)]", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: Número de orden de medicamentos o número de receta]", "example": [ { "label": "General", "valueString": "123456" } ], "id": "RequestGroup.groupIdentifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "RequestGroup.groupIdentifier.value", "short": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: Número de orden de medicamentos o número de receta]", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "RequestGroup.groupIdentifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "RequestGroup.groupIdentifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "RequestGroup.groupIdentifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 1, "path": "RequestGroup.groupIdentifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 1, "path": "RequestGroup.status" }, "binding": { "description": "Codes identifying the lifecycle stage of a request.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-status|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The current state of the request. For request groups, the status reflects the status of all the requests in the group.", "id": "RequestGroup.status", "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, "mapping": [ { "identity": "workflow", "map": "Request.status" }, { "identity": "w5", "map": "FiveWs.status" } ], "max": "1", "min": 1, "path": "RequestGroup.status", "short": "draft | active | on-hold | revoked | completed | entered-in-error | unknown", "type": [ { "code": "code" } ] }, { "alias": [ "category" ], "base": { "max": "1", "min": 1, "path": "RequestGroup.intent" }, "binding": { "description": "Codes indicating the degree of authority/intentionality associated with a request.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestIntent" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-intent|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. [ES: Valor por defecto \"order\"]", "id": "RequestGroup.intent", "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, "mapping": [ { "identity": "workflow", "map": "Request.intent" }, { "identity": "w5", "map": "FiveWs.class" } ], "max": "1", "min": 1, "path": "RequestGroup.intent", "patternCode": "order", "requirements": "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.", "short": "Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. [ES: Valor por defecto \"order\"]", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.priority" }, "binding": { "description": "Identifies the level of importance to be assigned to actioning the request.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestPriority" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-priority|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates how quickly the request should be addressed with respect to other requests.", "id": "RequestGroup.priority", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.priority" }, { "identity": "w5", "map": "FiveWs.grade" } ], "max": "1", "meaningWhenMissing": "If missing, this request should be performed with normal priority", "min": 0, "path": "RequestGroup.priority", "short": "routine | urgent | asap | stat", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.code" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that identifies what the overall request group is.", "id": "RequestGroup.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.code" }, { "identity": "w5", "map": "FiveWs.what[x]" } ], "max": "0", "min": 0, "path": "RequestGroup.code", "short": "What's being requested/ordered", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.subject" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The subject for which the request group was created.", "id": "RequestGroup.subject", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.subject" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 1, "path": "RequestGroup.subject", "short": "Who the request group is about", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.encounter" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes the context of the request group, if any.", "id": "RequestGroup.encounter", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.encounter" }, { "identity": "w5", "map": "FiveWs.context" } ], "max": "1", "min": 1, "path": "RequestGroup.encounter", "short": "Created as part of", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.authoredOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates when the request group was created.", "id": "RequestGroup.authoredOn", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.authoredOn" }, { "identity": "w5", "map": "FiveWs.recorded" } ], "max": "0", "min": 0, "path": "RequestGroup.authoredOn", "short": "When the request group was authored", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.author" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reference to the author of the request group.", "id": "RequestGroup.author", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.requester" }, { "identity": "w5", "map": "FiveWs.author" } ], "max": "0", "min": 0, "path": "RequestGroup.author", "short": "Device or practitioner that authored the request group", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ] } ] }, { "base": { "max": "*", "min": 0, "path": "RequestGroup.reasonCode" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes the reason for the request group in coded or textual form.", "id": "RequestGroup.reasonCode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.reasonCode" }, { "identity": "w5", "map": "FiveWs.why[x]" } ], "max": "0", "min": 0, "path": "RequestGroup.reasonCode", "short": "Why the request group is needed", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "RequestGroup.reasonReference" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates another resource whose existence justifies this request group.", "id": "RequestGroup.reasonReference", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.reasonReference" }, { "identity": "w5", "map": "FiveWs.why[x]" } ], "max": "0", "min": 0, "path": "RequestGroup.reasonReference", "short": "Why the request group is needed", "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" ] } ] }, { "base": { "max": "*", "min": 0, "path": "RequestGroup.note" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a mechanism to communicate additional information about the response.", "id": "RequestGroup.note", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.note" } ], "max": "0", "min": 0, "path": "RequestGroup.note", "short": "Additional notes about the response", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "*", "min": 0, "path": "RequestGroup.action" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "resource.exists() != action.exists()", "human": "Must have resource or action but not both", "key": "rqg-1", "severity": "error", "xpath": "exists(f:resource) != exists(f:action)" } ], "definition": "The actions, if any, produced by the evaluation of the artifact.", "id": "RequestGroup.action", "isModifier": false, "isSummary": false, "max": "*", "min": 1, "path": "RequestGroup.action", "short": "Proposed actions, if any", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "RequestGroup.action.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "RequestGroup.action.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "RequestGroup.action.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "RequestGroup.action.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "RequestGroup.action.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "RequestGroup.action.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.prefix" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A user-visible prefix for the action.", "id": "RequestGroup.action.prefix", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "RequestGroup.action.prefix", "short": "User-visible prefix for the action (e.g. 1. or A.)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.title" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The title of the action displayed to a user.", "id": "RequestGroup.action.title", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "RequestGroup.action.title", "short": "User-visible title", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.description" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A short description of the action used to provide a summary to display to the user.", "id": "RequestGroup.action.description", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "RequestGroup.action.description", "short": "Short description of the action", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.textEquivalent" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "RequestGroup.action.textEquivalent", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "RequestGroup.action.textEquivalent", "short": "Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.priority" }, "binding": { "description": "Identifies the level of importance to be assigned to actioning the request.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestPriority" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-priority|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates how quickly the action should be addressed with respect to other actions.", "id": "RequestGroup.action.priority", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.priority" } ], "max": "0", "min": 0, "path": "RequestGroup.action.priority", "short": "routine | urgent | asap | stat", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "RequestGroup.action.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "RequestGroup.action.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.code" } ], "max": "0", "min": 0, "path": "RequestGroup.action.code", "short": "Code representing the meaning of the action or sub-actions", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "RequestGroup.action.documentation" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "RequestGroup.action.documentation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.supportingInfo" } ], "max": "0", "min": 0, "path": "RequestGroup.action.documentation", "short": "Supporting documentation for the intended performer of the action", "type": [ { "code": "RelatedArtifact" } ] }, { "base": { "max": "*", "min": 0, "path": "RequestGroup.action.condition" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An expression that describes applicability criteria, or start/stop conditions for the action.", "id": "RequestGroup.action.condition", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "RequestGroup.action.condition", "short": "Whether or not the action is applicable", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "RequestGroup.action.condition.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "RequestGroup.action.condition.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "RequestGroup.action.condition.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "RequestGroup.action.condition.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "RequestGroup.action.condition.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "RequestGroup.action.condition.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "RequestGroup.action.condition.kind" }, "binding": { "description": "The kind of condition for the action.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionConditionKind" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The kind of condition.", "id": "RequestGroup.action.condition.kind", "isModifier": false, "isSummary": false, "max": "1", "min": 1, "path": "RequestGroup.action.condition.kind", "short": "applicability | start | stop", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.condition.expression" }, "comment": "The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An expression that returns true or false, indicating whether or not the condition is satisfied.", "id": "RequestGroup.action.condition.expression", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "RequestGroup.action.condition.expression", "short": "Boolean-valued expression", "type": [ { "code": "Expression" } ] }, { "base": { "max": "*", "min": 0, "path": "RequestGroup.action.relatedAction" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".", "id": "RequestGroup.action.relatedAction", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "RequestGroup.action.relatedAction", "short": "Relationship to another action", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "RequestGroup.action.relatedAction.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "RequestGroup.action.relatedAction.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "RequestGroup.action.relatedAction.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "RequestGroup.action.relatedAction.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "RequestGroup.action.relatedAction.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "RequestGroup.action.relatedAction.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "RequestGroup.action.relatedAction.actionId" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The element id of the action this is related to.", "id": "RequestGroup.action.relatedAction.actionId", "isModifier": false, "isSummary": false, "max": "1", "min": 1, "path": "RequestGroup.action.relatedAction.actionId", "short": "What action this is related to", "type": [ { "code": "id" } ] }, { "base": { "max": "1", "min": 1, "path": "RequestGroup.action.relatedAction.relationship" }, "binding": { "description": "Defines the types of relationships between actions.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionRelationshipType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The relationship of this action to the related action.", "id": "RequestGroup.action.relatedAction.relationship", "isModifier": false, "isSummary": false, "max": "1", "min": 1, "path": "RequestGroup.action.relatedAction.relationship", "short": "before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.relatedAction.offset[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.", "id": "RequestGroup.action.relatedAction.offset[x]", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "RequestGroup.action.relatedAction.offset[x]", "short": "Time offset for the relationship", "type": [ { "code": "Duration" }, { "code": "Range" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.timing[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An optional value describing when the action should be performed.", "id": "RequestGroup.action.timing[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.occurrence[x]" } ], "max": "0", "min": 0, "path": "RequestGroup.action.timing[x]", "short": "When the action should take place", "type": [ { "code": "dateTime" }, { "code": "Age" }, { "code": "Period" }, { "code": "Duration" }, { "code": "Range" }, { "code": "Timing" } ] }, { "base": { "max": "*", "min": 0, "path": "RequestGroup.action.participant" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The participant that should perform or be responsible for this action.", "id": "RequestGroup.action.participant", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.performer" }, { "identity": "w5", "map": "FiveWs.actor" } ], "max": "0", "min": 0, "path": "RequestGroup.action.participant", "short": "Who should perform the action", "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" ] } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.type" }, "binding": { "description": "The type of action to be performed.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionType" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/action-type" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The type of action to perform (create, update, remove).", "id": "RequestGroup.action.type", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "RequestGroup.action.type", "short": "create | update | remove | fire-event", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.groupingBehavior" }, "binding": { "description": "Defines organization behavior of a group.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionGroupingBehavior" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Defines the grouping behavior for the action and its children.", "id": "RequestGroup.action.groupingBehavior", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "RequestGroup.action.groupingBehavior", "short": "visual-group | logical-group | sentence-group", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.selectionBehavior" }, "binding": { "description": "Defines selection behavior of a group.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionSelectionBehavior" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Defines the selection behavior for the action and its children.", "id": "RequestGroup.action.selectionBehavior", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "RequestGroup.action.selectionBehavior", "short": "any | all | all-or-none | exactly-one | at-most-one | one-or-more", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.requiredBehavior" }, "binding": { "description": "Defines expectations around whether an action or action group is required.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionRequiredBehavior" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Defines expectations around whether an action is required.", "id": "RequestGroup.action.requiredBehavior", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "RequestGroup.action.requiredBehavior", "short": "must | could | must-unless-documented", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.precheckBehavior" }, "binding": { "description": "Defines selection frequency behavior for an action or group.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionPrecheckBehavior" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Defines whether the action should usually be preselected.", "id": "RequestGroup.action.precheckBehavior", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "RequestGroup.action.precheckBehavior", "short": "yes | no", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.cardinalityBehavior" }, "binding": { "description": "Defines behavior for an action or a group for how many times that item may be repeated.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionCardinalityBehavior" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Defines whether the action can be selected multiple times.", "id": "RequestGroup.action.cardinalityBehavior", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "RequestGroup.action.cardinalityBehavior", "short": "single | multiple", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "RequestGroup.action.resource" }, "comment": "The target resource SHALL be a [Request](request.html) resource with a Request.intent set to \"option\".", "condition": [ "rqg-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The resource that is the target of the action (e.g. CommunicationRequest). [ES: Se hace referencia a cada uno de los MedicationRequest que componen la receta u orden de medicamentos]", "id": "RequestGroup.action.resource", "isModifier": false, "isSummary": false, "max": "1", "min": 1, "path": "RequestGroup.action.resource", "short": "The resource that is the target of the action (e.g. CommunicationRequest). [ES: Se hace referencia a cada uno de los MedicationRequest que componen la receta u orden de medicamentos]", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/MedicationRequestOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "RequestGroup.action.action" }, "condition": [ "rqg-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#RequestGroup.action", "definition": "Sub actions.", "id": "RequestGroup.action.action", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "RequestGroup.action.action", "short": "Sub action" } ] }, "status": "draft", "title": "OneHealth RequestGroup", "type": "RequestGroup", "url": "https://fhir.onehealth.com.pe/StructureDefinition/RequestGroupOH", "version": "2.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/PractitionerRoleOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2023-12-05", "derivation": "constraint", "description": "FHIR PractitionerRoleOH OrganizationOH, for OH interoperability scenarios, based on the national CORE PractitionerRole Profile defined by HL7 OH.", "differential": { "element": [ { "id": "PractitionerRole.identifier.system", "min": 1, "path": "PractitionerRole.identifier.system" }, { "id": "PractitionerRole.identifier.value", "min": 1, "path": "PractitionerRole.identifier.value" }, { "id": "PractitionerRole.active", "min": 1, "path": "PractitionerRole.active" }, { "id": "PractitionerRole.period.start", "min": 1, "path": "PractitionerRole.period.start" }, { "id": "PractitionerRole.practitioner", "min": 1, "path": "PractitionerRole.practitioner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH" ] } ] }, { "id": "PractitionerRole.organization", "min": 1, "path": "PractitionerRole.organization", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/practitioner-role" }, "id": "PractitionerRole.code", "min": 1, "path": "PractitionerRole.code" }, { "id": "PractitionerRole.code.coding", "min": 1, "path": "PractitionerRole.code.coding" }, { "id": "PractitionerRole.code.coding.version", "max": "0", "path": "PractitionerRole.code.coding.version" }, { "id": "PractitionerRole.code.coding.userSelected", "max": "0", "path": "PractitionerRole.code.coding.userSelected" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/c80-practice-codes" }, "id": "PractitionerRole.specialty", "path": "PractitionerRole.specialty" }, { "id": "PractitionerRole.specialty.coding", "min": 1, "path": "PractitionerRole.specialty.coding" }, { "id": "PractitionerRole.specialty.coding.system", "min": 1, "path": "PractitionerRole.specialty.coding.system", "patternUri": "http://snomed.info/sct" }, { "id": "PractitionerRole.specialty.coding.version", "max": "0", "path": "PractitionerRole.specialty.coding.version" }, { "id": "PractitionerRole.specialty.coding.code", "min": 1, "path": "PractitionerRole.specialty.coding.code" }, { "id": "PractitionerRole.specialty.coding.display", "min": 1, "path": "PractitionerRole.specialty.coding.display" }, { "id": "PractitionerRole.specialty.coding.userSelected", "max": "0", "path": "PractitionerRole.specialty.coding.userSelected" }, { "id": "PractitionerRole.location", "path": "PractitionerRole.location", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/LocationOH" ] } ] }, { "id": "PractitionerRole.healthcareService", "min": 1, "path": "PractitionerRole.healthcareService", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/HealthcareServiceOH" ] } ] }, { "id": "PractitionerRole.availableTime.daysOfWeek", "min": 1, "path": "PractitionerRole.availableTime.daysOfWeek" }, { "id": "PractitionerRole.availableTime.allDay", "min": 1, "path": "PractitionerRole.availableTime.allDay" }, { "id": "PractitionerRole.notAvailable.during", "min": 1, "path": "PractitionerRole.notAvailable.during" }, { "id": "PractitionerRole.notAvailable.during.start", "min": 1, "path": "PractitionerRole.notAvailable.during.start" }, { "id": "PractitionerRole.notAvailable.during.end", "min": 1, "path": "PractitionerRole.notAvailable.during.end" }, { "id": "PractitionerRole.endpoint", "max": "0", "path": "PractitionerRole.endpoint" } ] }, "fhirVersion": "4.0.1", "id": "PractitionerRoleOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "servd", "name": "ServD", "uri": "http://www.omg.org/spec/ServD/1.0/" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" } ], "meta": { "lastUpdated": "2024-04-12T17:46:27.668073+00:00", "versionId": "MTcxMjk0Mzk4NzY2ODA3MzAwMA" }, "name": "PractitionerRoleOH", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "PractitionerRole" }, "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.", "id": "PractitionerRole", "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" } ], "max": "*", "min": 0, "path": "PractitionerRole", "short": "Roles/organizations the practitioner is associated with" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "PractitionerRole.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "PractitionerRole.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PractitionerRole.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "PractitionerRole.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PractitionerRole.implicitRules", "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, "max": "1", "min": 0, "path": "PractitionerRole.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "PractitionerRole.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PractitionerRole.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PractitionerRole.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "PractitionerRole.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "PractitionerRole.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "PractitionerRole.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PractitionerRole.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "PractitionerRole.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "PractitionerRole.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "PractitionerRole.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "PractitionerRole.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Business Identifiers that are specific to a role/location.", "id": "PractitionerRole.identifier", "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" } ], "max": "*", "min": 0, "path": "PractitionerRole.identifier", "requirements": "Often, specific identities are assigned for the agent.", "short": "Business Identifiers that are specific to a role/location", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PractitionerRole.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PractitionerRole.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PractitionerRole.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PractitionerRole.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "PractitionerRole.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 0, "path": "PractitionerRole.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "PractitionerRole.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 0, "path": "PractitionerRole.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "PractitionerRole.identifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 1, "path": "PractitionerRole.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "example": [ { "label": "General", "valueString": "123456" } ], "id": "PractitionerRole.identifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "PractitionerRole.identifier.value", "short": "The value that is unique", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "PractitionerRole.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "1", "min": 0, "path": "PractitionerRole.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "PractitionerRole.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 0, "path": "PractitionerRole.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "PractitionerRole.active" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Whether this practitioner role record is in active use.", "id": "PractitionerRole.active", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.status" }, { "identity": "v2", "map": "STF-7" }, { "identity": "rim", "map": ".statusCode" } ], "max": "1", "meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element", "min": 1, "path": "PractitionerRole.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.", "short": "Whether this practitioner role record is in active use", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "PractitionerRole.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.", "id": "PractitionerRole.period", "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)" } ], "max": "1", "min": 0, "path": "PractitionerRole.period", "requirements": "Even after the agencies is revoked, the fact that it existed must still be recorded.", "short": "The period during which the practitioner is authorized to perform in these role(s)", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PractitionerRole.period.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PractitionerRole.period.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PractitionerRole.period.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PractitionerRole.period.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.start" }, "comment": "If the low element is missing, the meaning is that the low boundary is not known.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The start of the period. The boundary is inclusive.", "id": "PractitionerRole.period.start", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ], "max": "1", "min": 1, "path": "PractitionerRole.period.start", "short": "Starting time with inclusive boundary", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.end" }, "comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "id": "PractitionerRole.period.end", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ], "max": "1", "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "min": 0, "path": "PractitionerRole.period.end", "short": "End time with inclusive boundary, if not ongoing", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "PractitionerRole.practitioner" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Practitioner that is able to provide the defined services for the organization.", "id": "PractitionerRole.practitioner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".player" } ], "max": "1", "min": 1, "path": "PractitionerRole.practitioner", "short": "Practitioner that is able to provide the defined services for the organization", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "PractitionerRole.organization" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The organization where the Practitioner performs the roles associated.", "id": "PractitionerRole.organization", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".scoper" } ], "max": "1", "min": 1, "path": "PractitionerRole.organization", "short": "Organization where the roles are available", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "PractitionerRole.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/practitioner-role" }, "comment": "A person may have more than one role.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Roles which this practitioner is authorized to perform for the organization.", "id": "PractitionerRole.code", "isModifier": false, "isSummary": true, "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)" } ], "max": "*", "min": 1, "path": "PractitionerRole.code", "requirements": "Need to know what authority the practitioner has - what can they do?", "short": "Roles which this practitioner may perform", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PractitionerRole.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PractitionerRole.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PractitionerRole.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PractitionerRole.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "PractitionerRole.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 1, "path": "PractitionerRole.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PractitionerRole.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PractitionerRole.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PractitionerRole.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PractitionerRole.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "PractitionerRole.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 0, "path": "PractitionerRole.code.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "PractitionerRole.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "PractitionerRole.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "PractitionerRole.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 0, "path": "PractitionerRole.code.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "PractitionerRole.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 0, "path": "PractitionerRole.code.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "PractitionerRole.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "PractitionerRole.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "PractitionerRole.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "PractitionerRole.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "PractitionerRole.specialty" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/c80-practice-codes" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specific specialty of the practitioner.", "id": "PractitionerRole.specialty", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRA-5" }, { "identity": "rim", "map": ".player.HealthCareProvider[@classCode = 'PROV'].code" }, { "identity": "servd", "map": "./Specialty" } ], "max": "*", "min": 0, "path": "PractitionerRole.specialty", "short": "Specific specialty of the practitioner", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PractitionerRole.specialty.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PractitionerRole.specialty.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PractitionerRole.specialty.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PractitionerRole.specialty.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "PractitionerRole.specialty.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 1, "path": "PractitionerRole.specialty.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PractitionerRole.specialty.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PractitionerRole.specialty.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PractitionerRole.specialty.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PractitionerRole.specialty.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "PractitionerRole.specialty.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "PractitionerRole.specialty.coding.system", "patternUri": "http://snomed.info/sct", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "PractitionerRole.specialty.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "PractitionerRole.specialty.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "PractitionerRole.specialty.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "PractitionerRole.specialty.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "PractitionerRole.specialty.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "PractitionerRole.specialty.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "PractitionerRole.specialty.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "PractitionerRole.specialty.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "PractitionerRole.specialty.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "PractitionerRole.specialty.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "PractitionerRole.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location(s) at which this practitioner provides care.", "id": "PractitionerRole.location", "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)<br/> However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)" } ], "max": "*", "min": 0, "path": "PractitionerRole.location", "short": "The location(s) at which this practitioner provides care", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/LocationOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "PractitionerRole.healthcareService" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The list of healthcare services that this worker provides for this role's Organization/Location(s).", "id": "PractitionerRole.healthcareService", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "EDU-2 / AFF-3" }, { "identity": "rim", "map": ".player.QualifiedEntity[@classCode = 'QUAL'].code" } ], "max": "*", "min": 1, "path": "PractitionerRole.healthcareService", "short": "The list of healthcare services that this worker provides for this role's Organization/Location(s)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/HealthcareServiceOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "PractitionerRole.telecom" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Contact details that are specific to the role/location/service.", "id": "PractitionerRole.telecom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".telecom" } ], "max": "*", "min": 0, "path": "PractitionerRole.telecom", "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.", "short": "Contact details that are specific to the role/location/service", "type": [ { "code": "ContactPoint" } ] }, { "base": { "max": "*", "min": 0, "path": "PractitionerRole.availableTime" }, "comment": "More detailed availability information may be provided in associated Schedule/Slot resources.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.", "id": "PractitionerRole.availableTime", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "*", "min": 0, "path": "PractitionerRole.availableTime", "short": "Times the Service Site is available", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PractitionerRole.availableTime.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PractitionerRole.availableTime.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PractitionerRole.availableTime.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PractitionerRole.availableTime.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "PractitionerRole.availableTime.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "PractitionerRole.availableTime.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "PractitionerRole.availableTime.daysOfWeek" }, "binding": { "description": "The days of the week.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DaysOfWeek" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/days-of-week|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates which days of the week are available between the start and end Times.", "id": "PractitionerRole.availableTime.daysOfWeek", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "*", "min": 1, "path": "PractitionerRole.availableTime.daysOfWeek", "short": "mon | tue | wed | thu | fri | sat | sun", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "PractitionerRole.availableTime.allDay" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Is this always available? (hence times are irrelevant) e.g. 24 hour service.", "id": "PractitionerRole.availableTime.allDay", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 1, "path": "PractitionerRole.availableTime.allDay", "short": "Always available? e.g. 24 hour service", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "PractitionerRole.availableTime.availableStartTime" }, "comment": "The timezone is expected to be for where this HealthcareService is provided at.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.", "id": "PractitionerRole.availableTime.availableStartTime", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 0, "path": "PractitionerRole.availableTime.availableStartTime", "short": "Opening time of day (ignored if allDay = true)", "type": [ { "code": "time" } ] }, { "base": { "max": "1", "min": 0, "path": "PractitionerRole.availableTime.availableEndTime" }, "comment": "The timezone is expected to be for where this HealthcareService is provided at.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.", "id": "PractitionerRole.availableTime.availableEndTime", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 0, "path": "PractitionerRole.availableTime.availableEndTime", "short": "Closing time of day (ignored if allDay = true)", "type": [ { "code": "time" } ] }, { "base": { "max": "*", "min": 0, "path": "PractitionerRole.notAvailable" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The practitioner is not available or performing this role during this period of time due to the provided reason.", "id": "PractitionerRole.notAvailable", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "*", "min": 0, "path": "PractitionerRole.notAvailable", "short": "Not available during this time due to provided reason", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PractitionerRole.notAvailable.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PractitionerRole.notAvailable.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PractitionerRole.notAvailable.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PractitionerRole.notAvailable.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "PractitionerRole.notAvailable.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "PractitionerRole.notAvailable.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "PractitionerRole.notAvailable.description" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The reason that can be presented to the user as to why this time is not available.", "id": "PractitionerRole.notAvailable.description", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "PractitionerRole.notAvailable.description", "short": "Reason presented to the user explaining why time not available", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "PractitionerRole.notAvailable.during" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Service is not available (seasonally or for a public holiday) from this date.", "id": "PractitionerRole.notAvailable.during", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 1, "path": "PractitionerRole.notAvailable.during", "short": "Service not available from this date", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PractitionerRole.notAvailable.during.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PractitionerRole.notAvailable.during.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PractitionerRole.notAvailable.during.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PractitionerRole.notAvailable.during.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.start" }, "comment": "If the low element is missing, the meaning is that the low boundary is not known.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The start of the period. The boundary is inclusive.", "id": "PractitionerRole.notAvailable.during.start", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ], "max": "1", "min": 1, "path": "PractitionerRole.notAvailable.during.start", "short": "Starting time with inclusive boundary", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.end" }, "comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "id": "PractitionerRole.notAvailable.during.end", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ], "max": "1", "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "min": 1, "path": "PractitionerRole.notAvailable.during.end", "short": "End time with inclusive boundary, if not ongoing", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "PractitionerRole.availabilityExceptions" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PractitionerRole.availabilityExceptions", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 0, "path": "PractitionerRole.availabilityExceptions", "short": "Description of availability exceptions", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "PractitionerRole.endpoint" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Technical endpoints providing access to services operated for the practitioner with this role.", "id": "PractitionerRole.endpoint", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "PractitionerRole.endpoint", "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.", "short": "Technical endpoints providing access to services operated for the practitioner with this role", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Endpoint" ] } ] } ] }, "status": "draft", "title": "OneHealth PractitionerRole", "type": "PractitionerRole", "url": "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/PractitionerOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Practitioner", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR PractitionerOH Profile, for OH interoperability scenarios, based on the national CORE Practitioner Profile defined by HL7 OH.", "differential": { "element": [ { "definition": "Identifiers of the practitioner. [ES: identificación del Profesional]", "id": "Practitioner.identifier", "label": "Identificación", "min": 1, "path": "Practitioner.identifier", "short": "Identifiers of the practitioner. [ES: identificación del Profesional]", "slicing": { "description": "Types of practitioner identifiers.", "discriminator": [ { "path": "id", "type": "pattern" } ], "rules": "closed" } }, { "id": "Practitioner.identifier:NationalPersonIdentifier", "max": "*", "min": 1, "path": "Practitioner.identifier", "sliceName": "NationalPersonIdentifier" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.id", "min": 1, "path": "Practitioner.identifier.id", "patternString": "NationalPersonIdentifier-0" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.type", "min": 1, "path": "Practitioner.identifier.type" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding", "max": "2", "min": 2, "path": "Practitioner.identifier.type.coding", "slicing": { "description": "International coding and synonym (or equivalent) in Peru coding", "discriminator": [ { "path": "system", "type": "value" } ], "rules": "open" } }, { "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:InternationalCode", "max": "1", "min": 1, "path": "Practitioner.identifier.type.coding", "sliceName": "InternationalCode" }, { "definition": "International code system of identifiers for persons. [ES: Codificación internacional de identificaciones para personas (Ej: NNPER = Identificador Nacional de Persona Peruano | PPN = Pasaporte)]", "fixedUri": "http://terminology.hl7.org/CodeSystem/v2-0203", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:InternationalCode.system", "min": 1, "path": "Practitioner.identifier.type.coding.system", "short": "International code system" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:InternationalCode.version", "max": "0", "path": "Practitioner.identifier.type.coding.version" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:InternationalCode.code", "min": 1, "path": "Practitioner.identifier.type.coding.code" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:InternationalCode.display", "max": "0", "path": "Practitioner.identifier.type.coding.display" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:InternationalCode.userSelected", "max": "0", "path": "Practitioner.identifier.type.coding.userSelected" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:PeruCode", "max": "1", "min": 1, "path": "Practitioner.identifier.type.coding", "sliceName": "PeruCode" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:PeruCode.system", "min": 1, "path": "Practitioner.identifier.type.coding.system", "patternUri": "https://fhir.onehealth.com.pe/CodeSystem/PeruPersonIdentifiersOH" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:PeruCode.version", "max": "0", "path": "Practitioner.identifier.type.coding.version" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:PeruCode.code", "min": 1, "path": "Practitioner.identifier.type.coding.code", "short": "code : 1 = 'DNI' | 2 = 'Carnet de extranjería' | 3 = 'Pasaporte' | 4 = 'Documento de Identidad Extranjero' | 5 = ' Código Unico de Identificación (CUI) en Acta de Nacimiento' | 6 = 'Código Nacido Vivo (CNV)' | 7 = 'Sin Documento de Identidad'" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:PeruCode.display", "min": 1, "path": "Practitioner.identifier.type.coding.display" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:PeruCode.userSelected", "max": "0", "path": "Practitioner.identifier.type.coding.userSelected" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.type.text", "max": "0", "path": "Practitioner.identifier.type.text" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.system", "path": "Practitioner.identifier.system", "patternUri": "http://www.onehealth.com/reniec" }, { "definition": "Value of the Peru identification document. [ES: Valor del documento de identificación peruano]", "id": "Practitioner.identifier:NationalPersonIdentifier.value", "label": "Número de identificación", "min": 1, "path": "Practitioner.identifier.value", "short": "Identifier value" }, { "definition": "Period of validity of the identifier. [ES: Periódo de vigencia de la identificación]", "id": "Practitioner.identifier:NationalPersonIdentifier.period", "label": "Vigencia", "path": "Practitioner.identifier.period", "short": "Period of validity" }, { "definition": "Date of issuance of the identifier. [ES: Fecha de expedición de la identificación]", "id": "Practitioner.identifier:NationalPersonIdentifier.period.start", "label": "Fecha de expedición", "min": 1, "path": "Practitioner.identifier.period.start", "short": "Date of issuance" }, { "definition": "Identifier expiration date. [ES: Fecha de vencimiento de la identificación]", "id": "Practitioner.identifier:NationalPersonIdentifier.period.end", "label": "Fecha de vencimiento", "path": "Practitioner.identifier.period.end", "short": "Expiration date" }, { "id": "Practitioner.identifier:NationalPersonIdentifier.assigner", "path": "Practitioner.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Practitioner.identifier:NumeroColegiado", "max": "*", "min": 0, "path": "Practitioner.identifier", "sliceName": "NumeroColegiado" }, { "id": "Practitioner.identifier:NumeroColegiado.id", "min": 1, "path": "Practitioner.identifier.id", "patternString": "NumeroColegiado-0" }, { "id": "Practitioner.identifier:NumeroColegiado.use", "min": 1, "path": "Practitioner.identifier.use" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "id": "Practitioner.identifier:NumeroColegiado.type", "min": 1, "path": "Practitioner.identifier.type" }, { "id": "Practitioner.identifier:NumeroColegiado.type.coding", "max": "1", "min": 1, "path": "Practitioner.identifier.type.coding" }, { "id": "Practitioner.identifier:NumeroColegiado.type.coding.system", "min": 1, "path": "Practitioner.identifier.type.coding.system", "patternUri": "http://terminology.hl7.org/CodeSystem/v2-0203" }, { "id": "Practitioner.identifier:NumeroColegiado.type.coding.version", "max": "0", "path": "Practitioner.identifier.type.coding.version" }, { "id": "Practitioner.identifier:NumeroColegiado.type.coding.code", "min": 1, "path": "Practitioner.identifier.type.coding.code", "short": "Symbol in syntax defined by the system (Ej: #MD)" }, { "id": "Practitioner.identifier:NumeroColegiado.type.coding.display", "min": 1, "path": "Practitioner.identifier.type.coding.display", "short": "Representation defined by the system (Ej: Medical License number)" }, { "id": "Practitioner.identifier:NumeroColegiado.type.coding.userSelected", "max": "0", "path": "Practitioner.identifier.type.coding.userSelected" }, { "id": "Practitioner.identifier:NumeroColegiado.type.text", "max": "0", "path": "Practitioner.identifier.type.text" }, { "id": "Practitioner.identifier:NumeroColegiado.value", "min": 1, "path": "Practitioner.identifier.value" }, { "id": "Practitioner.identifier:NumeroColegiado.assigner", "min": 1, "path": "Practitioner.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Practitioner.active", "min": 1, "path": "Practitioner.active" }, { "id": "Practitioner.name", "max": "1", "path": "Practitioner.name" }, { "id": "Practitioner.name.id", "max": "0", "path": "Practitioner.name.id" }, { "id": "Practitioner.name.use", "max": "0", "path": "Practitioner.name.use" }, { "id": "Practitioner.name.text", "max": "0", "path": "Practitioner.name.text" }, { "id": "Practitioner.name.family", "max": "0", "path": "Practitioner.name.family" }, { "id": "Practitioner.name.given", "max": "0", "path": "Practitioner.name.given" }, { "id": "Practitioner.name.prefix", "max": "1", "path": "Practitioner.name.prefix" }, { "id": "Practitioner.name.suffix", "max": "0", "path": "Practitioner.name.suffix" }, { "id": "Practitioner.name.period", "max": "0", "path": "Practitioner.name.period" }, { "id": "Practitioner.telecom.system", "min": 1, "path": "Practitioner.telecom.system" }, { "id": "Practitioner.telecom.value", "min": 1, "path": "Practitioner.telecom.value" }, { "id": "Practitioner.address.type", "min": 1, "path": "Practitioner.address.type" }, { "id": "Practitioner.gender", "max": "0", "path": "Practitioner.gender" }, { "id": "Practitioner.birthDate", "max": "0", "path": "Practitioner.birthDate" }, { "id": "Practitioner.photo", "max": "0", "path": "Practitioner.photo" }, { "id": "Practitioner.qualification.code.coding", "min": 1, "path": "Practitioner.qualification.code.coding" }, { "id": "Practitioner.qualification.code.coding.system", "min": 1, "path": "Practitioner.qualification.code.coding.system" }, { "id": "Practitioner.qualification.code.coding.code", "min": 1, "path": "Practitioner.qualification.code.coding.code" }, { "id": "Practitioner.qualification.code.coding.display", "min": 1, "path": "Practitioner.qualification.code.coding.display" }, { "id": "Practitioner.communication", "max": "0", "path": "Practitioner.communication" } ] }, "fhirVersion": "4.0.1", "id": "PractitionerOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "servd", "name": "ServD", "uri": "http://www.omg.org/spec/ServD/1.0/" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" } ], "meta": { "lastUpdated": "2024-04-12T17:46:27.402228+00:00", "versionId": "MTcxMjk0Mzk4NzQwMjIyODAwMA" }, "name": "PractitionerOH", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Practitioner" }, "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "A person who is directly or indirectly involved in the provisioning of healthcare.", "id": "Practitioner", "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" } ], "max": "*", "min": 0, "path": "Practitioner", "short": "A person with a formal responsibility in the provisioning of healthcare or related services" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Practitioner.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Practitioner.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Practitioner.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Practitioner.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Practitioner.implicitRules", "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, "max": "1", "min": 0, "path": "Practitioner.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Practitioner.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Practitioner.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Practitioner.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Practitioner.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Practitioner.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Practitioner.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Practitioner.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Practitioner.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Practitioner.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Practitioner.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifiers of the practitioner. [ES: identificación del Profesional]", "id": "Practitioner.identifier", "isModifier": false, "isSummary": true, "label": "Identificación", "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "PRD-7 (or XCN.1)" }, { "identity": "rim", "map": "./id" }, { "identity": "servd", "map": "./Identifiers" } ], "max": "*", "min": 1, "path": "Practitioner.identifier", "requirements": "Often, specific identities are assigned for the agent.", "short": "Identifiers of the practitioner. [ES: identificación del Profesional]", "slicing": { "description": "Types of practitioner identifiers.", "discriminator": [ { "path": "id", "type": "pattern" } ], "rules": "closed" }, "type": [ { "code": "Identifier" } ] }, { "base": { "max": "*", "min": 0, "path": "Practitioner.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifiers of the practitioner. [ES: identificación del Profesional]", "id": "Practitioner.identifier:NationalPersonIdentifier", "isModifier": false, "isSummary": true, "label": "Identificación", "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "PRD-7 (or XCN.1)" }, { "identity": "rim", "map": "./id" }, { "identity": "servd", "map": "./Identifiers" } ], "max": "*", "min": 1, "path": "Practitioner.identifier", "requirements": "Often, specific identities are assigned for the agent.", "short": "Identifiers of the practitioner. [ES: identificación del Profesional]", "sliceName": "NationalPersonIdentifier", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.identifier:NationalPersonIdentifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.id", "patternString": "NationalPersonIdentifier-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.identifier:NationalPersonIdentifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "Practitioner.identifier:NationalPersonIdentifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 0, "path": "Practitioner.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "Practitioner.identifier:NationalPersonIdentifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.identifier:NationalPersonIdentifier.type.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Practitioner.identifier.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.identifier:NationalPersonIdentifier.type.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.identifier.type.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "2", "min": 2, "path": "Practitioner.identifier.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "slicing": { "description": "International coding and synonym (or equivalent) in Peru coding", "discriminator": [ { "path": "system", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Coding" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:InternationalCode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "sliceName": "InternationalCode", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:InternationalCode.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Practitioner.identifier.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:InternationalCode.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.identifier.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "International code system of identifiers for persons. [ES: Codificación internacional de identificaciones para personas (Ej: NNPER = Identificador Nacional de Persona Peruano | PPN = Pasaporte)]", "fixedUri": "http://terminology.hl7.org/CodeSystem/v2-0203", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:InternationalCode.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "International code system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:InternationalCode.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Practitioner.identifier.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:InternationalCode.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.type.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:InternationalCode.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "0", "min": 0, "path": "Practitioner.identifier.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:InternationalCode.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Practitioner.identifier.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:PeruCode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "sliceName": "PeruCode", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:PeruCode.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Practitioner.identifier.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:PeruCode.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.identifier.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:PeruCode.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.type.coding.system", "patternUri": "https://fhir.onehealth.com.pe/CodeSystem/PeruPersonIdentifiersOH", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:PeruCode.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Practitioner.identifier.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:PeruCode.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.type.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "code : 1 = 'DNI' | 2 = 'Carnet de extranjería' | 3 = 'Pasaporte' | 4 = 'Documento de Identidad Extranjero' | 5 = ' Código Unico de Identificación (CUI) en Acta de Nacimiento' | 6 = 'Código Nacido Vivo (CNV)' | 7 = 'Sin Documento de Identidad'", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:PeruCode.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Practitioner.identifier:NationalPersonIdentifier.type.coding:PeruCode.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Practitioner.identifier.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Practitioner.identifier:NationalPersonIdentifier.type.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Practitioner.identifier.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "Practitioner.identifier:NationalPersonIdentifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 0, "path": "Practitioner.identifier.system", "patternUri": "http://www.onehealth.com/reniec", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Value of the Peru identification document. [ES: Valor del documento de identificación peruano]", "example": [ { "label": "General", "valueString": "123456" } ], "id": "Practitioner.identifier:NationalPersonIdentifier.value", "isModifier": false, "isSummary": true, "label": "Número de identificación", "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.value", "short": "Identifier value", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Period of validity of the identifier. [ES: Periódo de vigencia de la identificación]", "id": "Practitioner.identifier:NationalPersonIdentifier.period", "isModifier": false, "isSummary": true, "label": "Vigencia", "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "1", "min": 0, "path": "Practitioner.identifier.period", "short": "Period of validity", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.identifier:NationalPersonIdentifier.period.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Practitioner.identifier.period.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.identifier:NationalPersonIdentifier.period.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.identifier.period.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.start" }, "comment": "If the low element is missing, the meaning is that the low boundary is not known.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Date of issuance of the identifier. [ES: Fecha de expedición de la identificación]", "id": "Practitioner.identifier:NationalPersonIdentifier.period.start", "isModifier": false, "isSummary": true, "label": "Fecha de expedición", "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.period.start", "short": "Date of issuance", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.end" }, "comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifier expiration date. [ES: Fecha de vencimiento de la identificación]", "id": "Practitioner.identifier:NationalPersonIdentifier.period.end", "isModifier": false, "isSummary": true, "label": "Fecha de vencimiento", "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ], "max": "1", "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "min": 0, "path": "Practitioner.identifier.period.end", "short": "Expiration date", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "Practitioner.identifier:NationalPersonIdentifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 0, "path": "Practitioner.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Practitioner.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifiers of the practitioner. [ES: identificación del Profesional]", "id": "Practitioner.identifier:NumeroColegiado", "isModifier": false, "isSummary": true, "label": "Identificación", "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "PRD-7 (or XCN.1)" }, { "identity": "rim", "map": "./id" }, { "identity": "servd", "map": "./Identifiers" } ], "max": "*", "min": 0, "path": "Practitioner.identifier", "requirements": "Often, specific identities are assigned for the agent.", "short": "Identifiers of the practitioner. [ES: identificación del Profesional]", "sliceName": "NumeroColegiado", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.identifier:NumeroColegiado.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.id", "patternString": "NumeroColegiado-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.identifier:NumeroColegiado.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "Practitioner.identifier:NumeroColegiado.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "Practitioner.identifier:NumeroColegiado.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.identifier:NumeroColegiado.type.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Practitioner.identifier.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.identifier:NumeroColegiado.type.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.identifier.type.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Practitioner.identifier:NumeroColegiado.type.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.identifier:NumeroColegiado.type.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Practitioner.identifier.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.identifier:NumeroColegiado.type.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.identifier.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Practitioner.identifier:NumeroColegiado.type.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.type.coding.system", "patternUri": "http://terminology.hl7.org/CodeSystem/v2-0203", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Practitioner.identifier:NumeroColegiado.type.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Practitioner.identifier.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Practitioner.identifier:NumeroColegiado.type.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.type.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system (Ej: #MD)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Practitioner.identifier:NumeroColegiado.type.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system (Ej: Medical License number)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Practitioner.identifier:NumeroColegiado.type.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Practitioner.identifier.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Practitioner.identifier:NumeroColegiado.type.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Practitioner.identifier.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "Practitioner.identifier:NumeroColegiado.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 0, "path": "Practitioner.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "example": [ { "label": "General", "valueString": "123456" } ], "id": "Practitioner.identifier:NumeroColegiado.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.value", "short": "The value that is unique", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "Practitioner.identifier:NumeroColegiado.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "1", "min": 0, "path": "Practitioner.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.identifier:NumeroColegiado.period.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Practitioner.identifier.period.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.identifier:NumeroColegiado.period.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.identifier.period.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.start" }, "comment": "If the low element is missing, the meaning is that the low boundary is not known.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The start of the period. The boundary is inclusive.", "id": "Practitioner.identifier:NumeroColegiado.period.start", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ], "max": "1", "min": 0, "path": "Practitioner.identifier.period.start", "short": "Starting time with inclusive boundary", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.end" }, "comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "id": "Practitioner.identifier:NumeroColegiado.period.end", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ], "max": "1", "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "min": 0, "path": "Practitioner.identifier.period.end", "short": "End time with inclusive boundary, if not ongoing", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "Practitioner.identifier:NumeroColegiado.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 1, "path": "Practitioner.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Practitioner.active" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Whether this practitioner's record is in active use.", "id": "Practitioner.active", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": "./statusCode" } ], "max": "1", "meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element", "min": 1, "path": "Practitioner.active", "requirements": "Need to be able to mark a practitioner record as not to be used because it was created in error.", "short": "Whether this practitioner's record is in active use", "type": [ { "code": "boolean" } ] }, { "base": { "max": "*", "min": 0, "path": "Practitioner.name" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The name(s) associated with the practitioner.", "id": "Practitioner.name", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XCN Components" }, { "identity": "rim", "map": "./name" }, { "identity": "servd", "map": "./PreferredName (GivenNames, FamilyName, TitleCode)" } ], "max": "1", "min": 0, "path": "Practitioner.name", "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.", "short": "The name(s) associated with the practitioner", "type": [ { "code": "HumanName" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.name.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Practitioner.name.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.name.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.name.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "HumanName.use" }, "binding": { "description": "The use of a human name.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "NameUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/name-use|4.0.1" }, "comment": "Applications can assume that a name is current unless it explicitly says that it is temporary or old.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the purpose for this name.", "id": "Practitioner.name.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.7, but often indicated by which field contains the name" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./NamePurpose" } ], "max": "0", "min": 0, "path": "Practitioner.name.use", "requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.", "short": "usual | official | temp | nickname | anonymous | old | maiden", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "HumanName.text" }, "comment": "Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.", "id": "Practitioner.name.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "implied by XPN.11" }, { "identity": "rim", "map": "./formatted" } ], "max": "0", "min": 0, "path": "Practitioner.name.text", "requirements": "A renderable, unencoded form.", "short": "Text representation of the full name", "type": [ { "code": "string" } ] }, { "alias": [ "surname" ], "base": { "max": "1", "min": 0, "path": "HumanName.family" }, "comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.", "id": "Practitioner.name.family", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.1/FN.1" }, { "identity": "rim", "map": "./part[partType = FAM]" }, { "identity": "servd", "map": "./FamilyName" } ], "max": "0", "min": 0, "path": "Practitioner.name.family", "short": "Family name (often called 'Surname')", "type": [ { "code": "string" } ] }, { "alias": [ "first name", "middle name" ], "base": { "max": "*", "min": 0, "path": "HumanName.given" }, "comment": "If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called \"first name\" since given names do not always come first.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Given name.", "id": "Practitioner.name.given", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.2 + XPN.3" }, { "identity": "rim", "map": "./part[partType = GIV]" }, { "identity": "servd", "map": "./GivenNames" } ], "max": "0", "min": 0, "orderMeaning": "Given Names appear in the correct order for presenting the name", "path": "Practitioner.name.given", "short": "Given names (not always 'first'). Includes middle names", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "HumanName.prefix" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.", "id": "Practitioner.name.prefix", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.5" }, { "identity": "rim", "map": "./part[partType = PFX]" }, { "identity": "servd", "map": "./TitleCode" } ], "max": "1", "min": 0, "orderMeaning": "Prefixes appear in the correct order for presenting the name", "path": "Practitioner.name.prefix", "short": "Parts that come before the name", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "HumanName.suffix" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.", "id": "Practitioner.name.suffix", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN/4" }, { "identity": "rim", "map": "./part[partType = SFX]" } ], "max": "0", "min": 0, "orderMeaning": "Suffixes appear in the correct order for presenting the name", "path": "Practitioner.name.suffix", "short": "Parts that come after the name", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "HumanName.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the period of time when this name was valid for the named person.", "id": "Practitioner.name.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.13 + XPN.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Practitioner.name.period", "requirements": "Allows names to be placed in historical context.", "short": "Time period when name was/is in use", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "Practitioner.telecom" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A contact detail for the practitioner, e.g. a telephone number or an email address.", "id": "Practitioner.telecom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRT-15, STF-10, ROL-12" }, { "identity": "rim", "map": "./telecom" }, { "identity": "servd", "map": "./ContactPoints" } ], "max": "*", "min": 0, "path": "Practitioner.telecom", "requirements": "Need to know how to reach a practitioner independent to any roles the practitioner may have.", "short": "A contact detail for the practitioner (that apply to all roles)", "type": [ { "code": "ContactPoint" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.telecom.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Practitioner.telecom.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.telecom.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.telecom.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.system" }, "binding": { "description": "Telecommunications form for contact point.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPointSystem" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1" }, "condition": [ "cpt-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.", "id": "Practitioner.telecom.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.3" }, { "identity": "rim", "map": "./scheme" }, { "identity": "servd", "map": "./ContactPointType" } ], "max": "1", "min": 1, "path": "Practitioner.telecom.system", "short": "phone | fax | email | pager | url | sms | other", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.value" }, "comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).", "id": "Practitioner.telecom.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.1 (or XTN.12)" }, { "identity": "rim", "map": "./url" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Practitioner.telecom.value", "requirements": "Need to support legacy numbers that are not in a tightly controlled format.", "short": "The actual contact point details", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.use" }, "binding": { "description": "Use of contact point.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPointUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1" }, "comment": "Applications can assume that a contact is current unless it explicitly says that it is temporary or old.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the purpose for the contact point.", "id": "Practitioner.telecom.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.2 - but often indicated by field" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./ContactPointPurpose" } ], "max": "1", "min": 0, "path": "Practitioner.telecom.use", "requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.", "short": "home | work | temp | old | mobile - purpose of this contact point", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.rank" }, "comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.", "id": "Practitioner.telecom.rank", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Practitioner.telecom.rank", "short": "Specify preferred order of use (1 = highest)", "type": [ { "code": "positiveInt" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period when the contact point was/is in use.", "id": "Practitioner.telecom.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "1", "min": 0, "path": "Practitioner.telecom.period", "short": "Time period when the contact point was/is in use", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "Practitioner.address" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Practitioner.address", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC-24, STF-11, ROL-11, PRT-14" }, { "identity": "rim", "map": "./addr" }, { "identity": "servd", "map": "./Addresses" } ], "max": "*", "min": 0, "path": "Practitioner.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.", "short": "Address(es) of the practitioner that are not role specific (typically home address)", "type": [ { "code": "Address" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.address.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Practitioner.address.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.address.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.address.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.use" }, "binding": { "description": "The use of an address.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/address-use|4.0.1" }, "comment": "Applications can assume that an address is current unless it explicitly says that it is temporary or old.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this address.", "example": [ { "label": "General", "valueCode": "home" } ], "id": "Practitioner.address.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.7" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./AddressPurpose" } ], "max": "1", "min": 0, "path": "Practitioner.address.use", "requirements": "Allows an appropriate address to be chosen from a list of many.", "short": "home | work | temp | old | billing - purpose of this address", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.type" }, "binding": { "description": "The type of an address (physical / postal).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/address-type|4.0.1" }, "comment": "The definition of Address states that \"address is intended to describe postal addresses, not physical locations\". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](location.html#) resource).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.", "example": [ { "label": "General", "valueCode": "both" } ], "id": "Practitioner.address.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.18" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "vcard", "map": "address type parameter" } ], "max": "1", "min": 1, "path": "Practitioner.address.type", "short": "postal | physical | both", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.text" }, "comment": "Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.", "example": [ { "label": "General", "valueString": "137 Nowhere Street, Erewhon 9132" } ], "id": "Practitioner.address.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6" }, { "identity": "rim", "map": "./formatted" }, { "identity": "vcard", "map": "address label parameter" } ], "max": "1", "min": 0, "path": "Practitioner.address.text", "requirements": "A renderable, unencoded form.", "short": "Text representation of the address", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Address.line" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.", "example": [ { "label": "General", "valueString": "137 Nowhere Street" } ], "id": "Practitioner.address.line", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "vcard", "map": "street" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ], "max": "*", "min": 0, "orderMeaning": "The order in which lines should appear in an address label", "path": "Practitioner.address.line", "short": "Street name, number, direction & P.O. Box etc.", "type": [ { "code": "string" } ] }, { "alias": [ "Municpality" ], "base": { "max": "1", "min": 0, "path": "Address.city" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The name of the city, town, suburb, village or other community or delivery center.", "example": [ { "label": "General", "valueString": "Erewhon" } ], "id": "Practitioner.address.city", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.3" }, { "identity": "rim", "map": "AD.part[parttype = CTY]" }, { "identity": "vcard", "map": "locality" }, { "identity": "servd", "map": "./Jurisdiction" } ], "max": "1", "min": 0, "path": "Practitioner.address.city", "short": "Name of city, town etc.", "type": [ { "code": "string" } ] }, { "alias": [ "County" ], "base": { "max": "1", "min": 0, "path": "Address.district" }, "comment": "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The name of the administrative area (county).", "example": [ { "label": "General", "valueString": "Madison" } ], "id": "Practitioner.address.district", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.9" }, { "identity": "rim", "map": "AD.part[parttype = CNT | CPA]" } ], "max": "1", "min": 0, "path": "Practitioner.address.district", "short": "District name (aka county)", "type": [ { "code": "string" } ] }, { "alias": [ "Province", "Territory" ], "base": { "max": "1", "min": 0, "path": "Address.state" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).", "id": "Practitioner.address.state", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.4" }, { "identity": "rim", "map": "AD.part[parttype = STA]" }, { "identity": "vcard", "map": "region" }, { "identity": "servd", "map": "./Region" } ], "max": "1", "min": 0, "path": "Practitioner.address.state", "short": "Sub-unit of country (abbreviations ok)", "type": [ { "code": "string" } ] }, { "alias": [ "Zip" ], "base": { "max": "1", "min": 0, "path": "Address.postalCode" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A postal code designating a region defined by the postal service.", "example": [ { "label": "General", "valueString": "9132" } ], "id": "Practitioner.address.postalCode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.5" }, { "identity": "rim", "map": "AD.part[parttype = ZIP]" }, { "identity": "vcard", "map": "code" }, { "identity": "servd", "map": "./PostalIdentificationCode" } ], "max": "1", "min": 0, "path": "Practitioner.address.postalCode", "short": "Postal code for area", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.country" }, "comment": "ISO 3166 3 letter codes can be used in place of a human readable country name.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Country - a nation as commonly understood or generally accepted.", "id": "Practitioner.address.country", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.6" }, { "identity": "rim", "map": "AD.part[parttype = CNT]" }, { "identity": "vcard", "map": "country" }, { "identity": "servd", "map": "./Country" } ], "max": "1", "min": 0, "path": "Practitioner.address.country", "short": "Country (e.g. can be ISO 3166 2 or 3 letter code)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period when address was/is in use.", "example": [ { "label": "General", "valuePeriod": { "end": "2010-07-01", "start": "2010-03-23" } } ], "id": "Practitioner.address.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.12 / XAD.13 + XAD.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "1", "min": 0, "path": "Practitioner.address.period", "requirements": "Allows addresses to be placed in historical context.", "short": "Time period when address was/is in use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Practitioner.gender" }, "binding": { "description": "The gender of a person used for administrative purposes.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdministrativeGender" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.", "id": "Practitioner.gender", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "STF-5" }, { "identity": "rim", "map": "./administrativeGender" }, { "identity": "servd", "map": "./GenderCode" } ], "max": "0", "min": 0, "path": "Practitioner.gender", "requirements": "Needed to address the person correctly.", "short": "male | female | other | unknown", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Practitioner.birthDate" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date of birth for the practitioner.", "id": "Practitioner.birthDate", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "STF-6" }, { "identity": "rim", "map": "./birthTime" }, { "identity": "servd", "map": "(not represented in ServD)" } ], "max": "0", "min": 0, "path": "Practitioner.birthDate", "requirements": "Needed for identification.", "short": "The date on which the practitioner was born", "type": [ { "code": "date" } ] }, { "base": { "max": "*", "min": 0, "path": "Practitioner.photo" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Image of the person.", "id": "Practitioner.photo", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./subjectOf/ObservationEvent[code=\"photo\"]/value" }, { "identity": "servd", "map": "./ImageURI (only supports the URI reference)" } ], "max": "0", "min": 0, "path": "Practitioner.photo", "requirements": "Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.", "short": "Image of the person", "type": [ { "code": "Attachment" } ] }, { "base": { "max": "*", "min": 0, "path": "Practitioner.qualification" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Practitioner.qualification", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "CER?" }, { "identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].code" }, { "identity": "servd", "map": "./Qualifications" } ], "max": "*", "min": 0, "path": "Practitioner.qualification", "short": "Certification, licenses, or training pertaining to the provision of care", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.qualification.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Practitioner.qualification.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.qualification.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.qualification.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Practitioner.qualification.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Practitioner.qualification.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Practitioner.qualification.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An identifier that applies to this person's qualification in this role.", "id": "Practitioner.qualification.identifier", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].id" } ], "max": "*", "min": 0, "path": "Practitioner.qualification.identifier", "requirements": "Often, specific identities are assigned for the qualification.", "short": "An identifier for this qualification for the practitioner", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 1, "path": "Practitioner.qualification.code" }, "binding": { "description": "Specific qualification the practitioner has to provide a service.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Qualification" } ], "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v2-2.7-0360" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Coded representation of the qualification.", "id": "Practitioner.qualification.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].code" }, { "identity": "servd", "map": "./Qualifications.Value" } ], "max": "1", "min": 1, "path": "Practitioner.qualification.code", "short": "Coded representation of the qualification", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.qualification.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Practitioner.qualification.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.qualification.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.qualification.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Practitioner.qualification.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 1, "path": "Practitioner.qualification.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Practitioner.qualification.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Practitioner.qualification.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Practitioner.qualification.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Practitioner.qualification.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Practitioner.qualification.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Practitioner.qualification.code.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Practitioner.qualification.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "1", "min": 0, "path": "Practitioner.qualification.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Practitioner.qualification.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Practitioner.qualification.code.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Practitioner.qualification.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Practitioner.qualification.code.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Practitioner.qualification.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "1", "min": 0, "path": "Practitioner.qualification.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Practitioner.qualification.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "Practitioner.qualification.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Practitioner.qualification.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Period during which the qualification is valid.", "id": "Practitioner.qualification.period", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].effectiveTime" }, { "identity": "servd", "map": "./Qualifications.StartDate and ./Qualifications.EndDate" } ], "max": "1", "min": 0, "path": "Practitioner.qualification.period", "requirements": "Qualifications are often for a limited period of time, and can be revoked.", "short": "Period during which the qualification is valid", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Practitioner.qualification.issuer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that regulates and issues the qualification.", "id": "Practitioner.qualification.issuer", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].scoper" } ], "max": "1", "min": 0, "path": "Practitioner.qualification.issuer", "short": "Organization that regulates and issues the qualification", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Practitioner.communication" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A language the practitioner can use in patient communication.", "id": "Practitioner.communication", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PID-15, NK1-20, LAN-2" }, { "identity": "rim", "map": "./languageCommunication" }, { "identity": "servd", "map": "./Languages.LanguageSpokenCode" } ], "max": "0", "min": 0, "path": "Practitioner.communication", "requirements": "Knowing which language a practitioner speaks can help in facilitating communication with patients.", "short": "A language the practitioner can use in patient communication", "type": [ { "code": "CodeableConcept" } ] } ] }, "status": "draft", "title": "OneHealth Practitioner", "type": "Practitioner", "url": "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH", "version": "2.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/PlanDefinitionOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2023-10-30", "derivation": "constraint", "description": "FHIR PlanDefinitionOH Profile, for OH interoperability scenarios, based on the national CORE PlanDefinition Profile defined by HL7 OH.", "differential": { "element": [ { "id": "PlanDefinition.identifier", "max": "1", "min": 1, "path": "PlanDefinition.identifier" }, { "id": "PlanDefinition.name", "min": 1, "path": "PlanDefinition.name" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/plan-definition-type" }, "id": "PlanDefinition.type", "path": "PlanDefinition.type" }, { "id": "PlanDefinition.type.coding.id", "max": "0", "path": "PlanDefinition.type.coding.id" }, { "id": "PlanDefinition.type.coding.system", "min": 1, "path": "PlanDefinition.type.coding.system" }, { "id": "PlanDefinition.type.coding.version", "max": "0", "path": "PlanDefinition.type.coding.version" }, { "id": "PlanDefinition.type.coding.code", "min": 1, "path": "PlanDefinition.type.coding.code" }, { "id": "PlanDefinition.type.coding.display", "min": 1, "path": "PlanDefinition.type.coding.display" }, { "id": "PlanDefinition.type.coding.userSelected", "max": "0", "path": "PlanDefinition.type.coding.userSelected" }, { "id": "PlanDefinition.type.text", "max": "0", "path": "PlanDefinition.type.text" }, { "id": "PlanDefinition.experimental", "max": "0", "path": "PlanDefinition.experimental" }, { "id": "PlanDefinition.subject[x]", "max": "0", "path": "PlanDefinition.subject[x]" }, { "id": "PlanDefinition.date", "max": "0", "path": "PlanDefinition.date" }, { "id": "PlanDefinition.contact", "max": "0", "path": "PlanDefinition.contact" }, { "id": "PlanDefinition.useContext", "max": "0", "path": "PlanDefinition.useContext" }, { "id": "PlanDefinition.jurisdiction", "max": "0", "path": "PlanDefinition.jurisdiction" }, { "id": "PlanDefinition.purpose", "max": "0", "path": "PlanDefinition.purpose" }, { "id": "PlanDefinition.copyright", "max": "0", "path": "PlanDefinition.copyright" }, { "id": "PlanDefinition.approvalDate", "max": "0", "path": "PlanDefinition.approvalDate" }, { "id": "PlanDefinition.lastReviewDate", "max": "0", "path": "PlanDefinition.lastReviewDate" }, { "id": "PlanDefinition.effectivePeriod", "max": "0", "path": "PlanDefinition.effectivePeriod" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/definition-topic" }, "id": "PlanDefinition.topic", "path": "PlanDefinition.topic" }, { "id": "PlanDefinition.topic.coding.id", "max": "0", "path": "PlanDefinition.topic.coding.id" }, { "id": "PlanDefinition.topic.coding.system", "min": 1, "path": "PlanDefinition.topic.coding.system" }, { "id": "PlanDefinition.topic.coding.version", "max": "0", "path": "PlanDefinition.topic.coding.version" }, { "id": "PlanDefinition.topic.coding.code", "min": 1, "path": "PlanDefinition.topic.coding.code" }, { "id": "PlanDefinition.topic.coding.display", "min": 1, "path": "PlanDefinition.topic.coding.display" }, { "id": "PlanDefinition.topic.coding.userSelected", "max": "0", "path": "PlanDefinition.topic.coding.userSelected" }, { "id": "PlanDefinition.topic.text", "max": "0", "path": "PlanDefinition.topic.text" }, { "id": "PlanDefinition.editor", "max": "0", "path": "PlanDefinition.editor" }, { "id": "PlanDefinition.reviewer", "max": "0", "path": "PlanDefinition.reviewer" }, { "id": "PlanDefinition.endorser", "max": "0", "path": "PlanDefinition.endorser" }, { "id": "PlanDefinition.relatedArtifact", "max": "0", "path": "PlanDefinition.relatedArtifact" }, { "id": "PlanDefinition.library", "max": "0", "path": "PlanDefinition.library" }, { "id": "PlanDefinition.goal", "max": "0", "path": "PlanDefinition.goal" }, { "id": "PlanDefinition.action", "min": 1, "path": "PlanDefinition.action" }, { "id": "PlanDefinition.action.title", "min": 1, "path": "PlanDefinition.action.title" }, { "id": "PlanDefinition.action.code", "max": "0", "path": "PlanDefinition.action.code" }, { "id": "PlanDefinition.action.reason", "max": "0", "path": "PlanDefinition.action.reason" }, { "id": "PlanDefinition.action.documentation", "max": "0", "path": "PlanDefinition.action.documentation" }, { "id": "PlanDefinition.action.goalId", "max": "0", "path": "PlanDefinition.action.goalId" }, { "id": "PlanDefinition.action.subject[x]", "max": "0", "path": "PlanDefinition.action.subject[x]" }, { "id": "PlanDefinition.action.trigger", "max": "0", "path": "PlanDefinition.action.trigger" }, { "id": "PlanDefinition.action.condition", "max": "0", "path": "PlanDefinition.action.condition" }, { "id": "PlanDefinition.action.input", "max": "0", "path": "PlanDefinition.action.input" }, { "id": "PlanDefinition.action.output", "max": "0", "path": "PlanDefinition.action.output" }, { "id": "PlanDefinition.action.relatedAction.offset[x]", "max": "0", "path": "PlanDefinition.action.relatedAction.offset[x]" }, { "id": "PlanDefinition.action.participant", "max": "0", "path": "PlanDefinition.action.participant" }, { "id": "PlanDefinition.action.type", "max": "0", "path": "PlanDefinition.action.type" }, { "id": "PlanDefinition.action.groupingBehavior", "max": "0", "path": "PlanDefinition.action.groupingBehavior" }, { "id": "PlanDefinition.action.selectionBehavior", "max": "0", "path": "PlanDefinition.action.selectionBehavior" }, { "id": "PlanDefinition.action.requiredBehavior", "max": "0", "path": "PlanDefinition.action.requiredBehavior" }, { "id": "PlanDefinition.action.precheckBehavior", "max": "0", "path": "PlanDefinition.action.precheckBehavior" }, { "id": "PlanDefinition.action.cardinalityBehavior", "max": "0", "path": "PlanDefinition.action.cardinalityBehavior" }, { "id": "PlanDefinition.action.definition[x]", "path": "PlanDefinition.action.definition[x]", "type": [ { "code": "canonical", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ActivityDefinitionOH" ] } ] }, { "id": "PlanDefinition.action.transform", "max": "0", "path": "PlanDefinition.action.transform" }, { "id": "PlanDefinition.action.dynamicValue", "max": "0", "path": "PlanDefinition.action.dynamicValue" }, { "id": "PlanDefinition.action.action", "max": "0", "path": "PlanDefinition.action.action" } ] }, "fhirVersion": "4.0.1", "id": "PlanDefinitionOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "objimpl", "name": "Object Implementation Information", "uri": "http://hl7.org/fhir/object-implementation" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" } ], "meta": { "lastUpdated": "2024-04-12T17:46:27.027566+00:00", "versionId": "MTcxMjk0Mzk4NzAyNzU2NjAwMA" }, "name": "PlanDefinitionOH", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "PlanDefinition" }, "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')", "human": "Name should be usable as an identifier for the module by machine processing applications such as code generation", "key": "pdf-0", "severity": "warning", "xpath": "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')" } ], "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.", "id": "PlanDefinition", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Definition" } ], "max": "*", "min": 0, "path": "PlanDefinition", "short": "The definition of a plan for a series of actions, independent of any specific patient or context" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "PlanDefinition.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "PlanDefinition.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "PlanDefinition.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.implicitRules", "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, "max": "1", "min": 0, "path": "PlanDefinition.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "PlanDefinition.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "PlanDefinition.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "PlanDefinition.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "PlanDefinition.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PlanDefinition.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "PlanDefinition.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "PlanDefinition.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "PlanDefinition.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.url" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.url", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.url" }, { "identity": "w5", "map": "FiveWs.identifier" } ], "max": "1", "min": 0, "path": "PlanDefinition.url", "requirements": "Allows the plan definition to be referenced by a single globally unique identifier.", "short": "Canonical identifier for this plan definition, represented as a URI (globally unique)", "type": [ { "code": "uri" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.identifier" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "objimpl", "map": "no-gen-base" } ], "max": "1", "min": 1, "path": "PlanDefinition.identifier", "requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.", "short": "Additional identifier for the plan definition", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.version" }, "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].", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.version" }, { "identity": "w5", "map": "FiveWs.version" } ], "max": "1", "min": 0, "path": "PlanDefinition.version", "short": "Business version of the plan definition", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.name" }, "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.", "condition": [ "inv-0" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.name", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "PlanDefinition.name", "requirements": "Support human navigation and code generation.", "short": "Name for this plan definition (computer friendly)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.title" }, "comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A short, descriptive, user-friendly title for the plan definition.", "id": "PlanDefinition.title", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.title" } ], "max": "1", "min": 0, "path": "PlanDefinition.title", "short": "Name for this plan definition (human friendly)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.subtitle" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An explanatory or alternate title for the plan definition giving additional information about its content.", "id": "PlanDefinition.subtitle", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.subtitle", "short": "Subordinate title of the plan definition", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.type" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/plan-definition-type" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.", "id": "PlanDefinition.type", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "PlanDefinition.type", "short": "order-set | clinical-protocol | eca-rule | workflow-definition", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PlanDefinition.type.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PlanDefinition.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PlanDefinition.type.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PlanDefinition.type.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "PlanDefinition.type.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "PlanDefinition.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PlanDefinition.type.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "PlanDefinition.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PlanDefinition.type.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PlanDefinition.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "PlanDefinition.type.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "PlanDefinition.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "PlanDefinition.type.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "PlanDefinition.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "PlanDefinition.type.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "PlanDefinition.type.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "PlanDefinition.type.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "PlanDefinition.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "PlanDefinition.type.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "PlanDefinition.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "PlanDefinition.type.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "PlanDefinition.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 1, "path": "PlanDefinition.status" }, "binding": { "description": "The lifecycle status of an artifact.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PublicationStatus" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/publication-status|4.0.1" }, "comment": "Allows filtering of plan definitions that are appropriate for use versus not.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status of this plan definition. Enables tracking the life-cycle of the content.", "id": "PlanDefinition.status", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration", "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.status {different ValueSet}" }, { "identity": "w5", "map": "FiveWs.status" } ], "max": "1", "min": 1, "path": "PlanDefinition.status", "short": "draft | active | retired | unknown", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.experimental" }, "comment": "Allows filtering of plan definitions that are appropriate for use versus not.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.experimental", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.experimental" }, { "identity": "w5", "map": "FiveWs.class" } ], "max": "0", "min": 0, "path": "PlanDefinition.experimental", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.", "short": "For testing purposes, not real usage", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.subject[x]" }, "binding": { "description": "The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SubjectType" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/subject-type" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code or group definition that describes the intended subject of the plan definition.", "id": "PlanDefinition.subject[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.subject" } ], "max": "0", "meaningWhenMissing": "Patient", "min": 0, "path": "PlanDefinition.subject[x]", "short": "Type of individual the plan definition is focused on", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Group" ] } ] }, { "alias": [ "Revision Date" ], "base": { "max": "1", "min": 0, "path": "PlanDefinition.date" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.date", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.date" }, { "identity": "w5", "map": "FiveWs.recorded" } ], "max": "0", "min": 0, "path": "PlanDefinition.date", "short": "Date last changed", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.publisher" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The name of the organization or individual that published the plan definition.", "id": "PlanDefinition.publisher", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.publisher" }, { "identity": "w5", "map": "FiveWs.witness" } ], "max": "1", "min": 0, "path": "PlanDefinition.publisher", "requirements": "Helps establish the \"authority/credibility\" of the plan definition. May also allow for contact.", "short": "Name of the publisher (organization or individual)", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.contact" }, "comment": "May be a web site, an email address, a telephone number, etc.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Contact details to assist a user in finding and communicating with the publisher.", "id": "PlanDefinition.contact", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.contact" } ], "max": "0", "min": 0, "path": "PlanDefinition.contact", "short": "Contact details for the publisher", "type": [ { "code": "ContactDetail" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.description" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A free text natural language description of the plan definition from a consumer's perspective.", "id": "PlanDefinition.description", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.description" } ], "max": "1", "min": 0, "path": "PlanDefinition.description", "short": "Natural language description of the plan definition", "type": [ { "code": "markdown" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.useContext" }, "comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.useContext", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.useContext" } ], "max": "0", "min": 0, "path": "PlanDefinition.useContext", "requirements": "Assist in searching for appropriate content.", "short": "The context that the content is intended to support", "type": [ { "code": "UsageContext" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.jurisdiction" }, "binding": { "description": "Countries and regions within which this artifact is targeted for use.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Jurisdiction" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/jurisdiction" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A legal or geographic region in which the plan definition is intended to be used.", "id": "PlanDefinition.jurisdiction", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.jurisdiction" } ], "max": "0", "min": 0, "path": "PlanDefinition.jurisdiction", "short": "Intended jurisdiction for plan definition (if applicable)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.purpose" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Explanation of why this plan definition is needed and why it has been designed as it has.", "id": "PlanDefinition.purpose", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.purpose" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "objimpl", "map": "no-gen-base" } ], "max": "0", "min": 0, "path": "PlanDefinition.purpose", "short": "Why this plan definition is defined", "type": [ { "code": "markdown" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.usage" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A detailed description of how the plan definition is used from a clinical perspective.", "id": "PlanDefinition.usage", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.usage", "short": "Describes the clinical usage of the plan", "type": [ { "code": "string" } ] }, { "alias": [ "License", "Restrictions" ], "base": { "max": "1", "min": 0, "path": "PlanDefinition.copyright" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.copyright", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.copyright" }, { "identity": "objimpl", "map": "no-gen-base" } ], "max": "0", "min": 0, "path": "PlanDefinition.copyright", "requirements": "Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content.", "short": "Use and/or publishing restrictions", "type": [ { "code": "markdown" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.approvalDate" }, "comment": "The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", "id": "PlanDefinition.approvalDate", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.approvalDate" }, { "identity": "objimpl", "map": "no-gen-base" } ], "max": "0", "min": 0, "path": "PlanDefinition.approvalDate", "short": "When the plan definition was approved by publisher", "type": [ { "code": "date" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.lastReviewDate" }, "comment": "If specified, this date follows the original approval date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.", "id": "PlanDefinition.lastReviewDate", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.lastReviewDate" }, { "identity": "objimpl", "map": "no-gen-base" } ], "max": "0", "min": 0, "path": "PlanDefinition.lastReviewDate", "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.", "short": "When the plan definition was last reviewed", "type": [ { "code": "date" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.effectivePeriod" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The period during which the plan definition content was or is planned to be in active use.", "id": "PlanDefinition.effectivePeriod", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.effectivePeriod" }, { "identity": "objimpl", "map": "no-gen-base" } ], "max": "0", "min": 0, "path": "PlanDefinition.effectivePeriod", "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.", "short": "When the plan definition is expected to be used", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.topic" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/definition-topic" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.topic", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.subject[x]" } ], "max": "*", "min": 0, "path": "PlanDefinition.topic", "requirements": "Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.", "short": "E.g. Education, Treatment, Assessment", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PlanDefinition.topic.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PlanDefinition.topic.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PlanDefinition.topic.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PlanDefinition.topic.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "PlanDefinition.topic.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "PlanDefinition.topic.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PlanDefinition.topic.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "PlanDefinition.topic.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PlanDefinition.topic.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PlanDefinition.topic.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "PlanDefinition.topic.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "PlanDefinition.topic.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "PlanDefinition.topic.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "PlanDefinition.topic.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "PlanDefinition.topic.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "PlanDefinition.topic.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "PlanDefinition.topic.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "PlanDefinition.topic.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "PlanDefinition.topic.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "PlanDefinition.topic.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "PlanDefinition.topic.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "PlanDefinition.topic.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.author" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An individiual or organization primarily involved in the creation and maintenance of the content.", "id": "PlanDefinition.author", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT]" } ], "max": "*", "min": 0, "path": "PlanDefinition.author", "short": "Who authored the content", "type": [ { "code": "ContactDetail" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.editor" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An individual or organization primarily responsible for internal coherence of the content.", "id": "PlanDefinition.editor", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.editor", "short": "Who edited the content", "type": [ { "code": "ContactDetail" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.reviewer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An individual or organization primarily responsible for review of some aspect of the content.", "id": "PlanDefinition.reviewer", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}" } ], "max": "0", "min": 0, "path": "PlanDefinition.reviewer", "short": "Who reviewed the content", "type": [ { "code": "ContactDetail" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.endorser" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An individual or organization responsible for officially endorsing the content for use in some setting.", "id": "PlanDefinition.endorser", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}" } ], "max": "0", "min": 0, "path": "PlanDefinition.endorser", "short": "Who endorsed the content", "type": [ { "code": "ContactDetail" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.relatedArtifact" }, "comment": "Each related artifact is either an attachment, or a reference to another resource, but not both.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Related artifacts such as additional documentation, justification, or bibliographic references.", "id": "PlanDefinition.relatedArtifact", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.relatedArtifact", "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.", "short": "Additional documentation, citations", "type": [ { "code": "RelatedArtifact" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.library" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a Library resource containing any formal logic used by the plan definition.", "id": "PlanDefinition.library", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.library", "short": "Logic used by the plan definition", "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Library" ] } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.goal" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.goal", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.goal", "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.", "short": "What the plan is trying to accomplish", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PlanDefinition.goal.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PlanDefinition.goal.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PlanDefinition.goal.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PlanDefinition.goal.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "PlanDefinition.goal.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "PlanDefinition.goal.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.goal.category" }, "binding": { "description": "Example codes for grouping goals for filtering or presentation.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalCategory" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/goal-category" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates a category the goal falls within.", "id": "PlanDefinition.goal.category", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.goal.category", "short": "E.g. Treatment, dietary, behavioral", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 1, "path": "PlanDefinition.goal.description" }, "binding": { "description": "Describes goals that can be achieved.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalDescription" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings" }, "comment": "If no code is available, use CodeableConcept.text.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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\".", "id": "PlanDefinition.goal.description", "isModifier": false, "isSummary": false, "max": "1", "min": 1, "path": "PlanDefinition.goal.description", "short": "Code or text describing the goal", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.goal.priority" }, "binding": { "description": "Indicates the level of importance associated with reaching or sustaining a goal.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalPriority" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/goal-priority" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the expected level of importance associated with reaching/sustaining the defined goal.", "id": "PlanDefinition.goal.priority", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.goal.priority", "short": "high-priority | medium-priority | low-priority", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.goal.start" }, "binding": { "description": "Identifies the types of events that might trigger the start of a goal.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalStartEvent" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/goal-start-event" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The event after which the goal should begin being pursued.", "id": "PlanDefinition.goal.start", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.goal.start", "short": "When goal pursuit begins", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.goal.addresses" }, "binding": { "description": "Identifies problems, conditions, issues, or concerns that goals may address.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalAddresses" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/condition-code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies problems, conditions, issues, or concerns the goal is intended to address.", "id": "PlanDefinition.goal.addresses", "isModifier": false, "isSummary": false, "max": "*", "min": 0, "path": "PlanDefinition.goal.addresses", "short": "What does the goal address", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.goal.documentation" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.goal.documentation", "isModifier": false, "isSummary": false, "max": "*", "min": 0, "path": "PlanDefinition.goal.documentation", "short": "Supporting documentation for the goal", "type": [ { "code": "RelatedArtifact" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.goal.target" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates what should be done and within what timeframe.", "id": "PlanDefinition.goal.target", "isModifier": false, "isSummary": false, "max": "*", "min": 0, "path": "PlanDefinition.goal.target", "short": "Target outcome for the goal", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PlanDefinition.goal.target.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PlanDefinition.goal.target.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PlanDefinition.goal.target.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PlanDefinition.goal.target.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "PlanDefinition.goal.target.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "PlanDefinition.goal.target.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.goal.target.measure" }, "binding": { "description": "Identifies types of parameters that can be tracked to determine goal achievement.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalTargetMeasure" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.", "id": "PlanDefinition.goal.target.measure", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.goal.target.measure", "short": "The parameter whose value is to be tracked", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.goal.target.detail[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.goal.target.detail[x]", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.goal.target.detail[x]", "short": "The target value to be achieved", "type": [ { "code": "Quantity" }, { "code": "Range" }, { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.goal.target.due" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the timeframe after the start of the goal in which the goal should be met.", "id": "PlanDefinition.goal.target.due", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.goal.target.due", "short": "Reach goal within", "type": [ { "code": "Duration" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.action" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An action or group of actions to be taken as part of the plan.", "id": "PlanDefinition.action", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "{Is a contained Definition}" } ], "max": "*", "min": 1, "path": "PlanDefinition.action", "short": "Action defined by the plan", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PlanDefinition.action.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PlanDefinition.action.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PlanDefinition.action.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PlanDefinition.action.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "PlanDefinition.action.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "PlanDefinition.action.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.prefix" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A user-visible prefix for the action.", "id": "PlanDefinition.action.prefix", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.action.prefix", "short": "User-visible prefix for the action (e.g. 1. or A.)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.title" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The title of the action displayed to a user.", "id": "PlanDefinition.action.title", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.title" } ], "max": "1", "min": 1, "path": "PlanDefinition.action.title", "short": "User-visible title", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.description" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A brief description of the action used to provide a summary to display to the user.", "id": "PlanDefinition.action.description", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.description" } ], "max": "1", "min": 0, "path": "PlanDefinition.action.description", "short": "Brief description of the action", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.textEquivalent" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.action.textEquivalent", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.description" } ], "max": "1", "min": 0, "path": "PlanDefinition.action.textEquivalent", "short": "Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.priority" }, "binding": { "description": "Identifies the level of importance to be assigned to actioning the request.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestPriority" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-priority|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates how quickly the action should be addressed with respect to other actions.", "id": "PlanDefinition.action.priority", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.action.priority", "short": "routine | urgent | asap | stat", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.action.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.action.code", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.code", "short": "Code representing the meaning of the action or sub-actions", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.action.reason" }, "comment": "This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A description of why this action is necessary or appropriate.", "id": "PlanDefinition.action.reason", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.reason", "short": "Why the action should be performed", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.action.documentation" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.action.documentation", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.documentation", "short": "Supporting documentation for the intended performer of the action", "type": [ { "code": "RelatedArtifact" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.action.goalId" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.", "id": "PlanDefinition.action.goalId", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.goalId", "short": "What goals this action supports", "type": [ { "code": "id" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.subject[x]" }, "binding": { "description": "The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SubjectType" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/subject-type" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code or group definition that describes the intended subject of the action and its children, if any.", "id": "PlanDefinition.action.subject[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.subject" } ], "max": "0", "meaningWhenMissing": "Patient", "min": 0, "path": "PlanDefinition.action.subject[x]", "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.", "short": "Type of individual the action is focused on", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Group" ] } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.action.trigger" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A description of when the action should be triggered.", "id": "PlanDefinition.action.trigger", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.trigger", "short": "When the action should be triggered", "type": [ { "code": "TriggerDefinition" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.action.condition" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An expression that describes applicability criteria or start/stop conditions for the action.", "id": "PlanDefinition.action.condition", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.condition", "short": "Whether or not the action is applicable", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PlanDefinition.action.condition.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PlanDefinition.action.condition.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PlanDefinition.action.condition.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PlanDefinition.action.condition.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "PlanDefinition.action.condition.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "PlanDefinition.action.condition.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "PlanDefinition.action.condition.kind" }, "binding": { "description": "Defines the kinds of conditions that can appear on actions.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionConditionKind" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The kind of condition.", "id": "PlanDefinition.action.condition.kind", "isModifier": false, "isSummary": false, "max": "1", "min": 1, "path": "PlanDefinition.action.condition.kind", "short": "applicability | start | stop", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.condition.expression" }, "comment": "The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An expression that returns true or false, indicating whether the condition is satisfied.", "id": "PlanDefinition.action.condition.expression", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.action.condition.expression", "short": "Boolean-valued expression", "type": [ { "code": "Expression" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.action.input" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Defines input data requirements for the action.", "id": "PlanDefinition.action.input", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.input", "short": "Input data requirements", "type": [ { "code": "DataRequirement" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.action.output" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Defines the outputs of the action, if any.", "id": "PlanDefinition.action.output", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.output", "short": "Output data definition", "type": [ { "code": "DataRequirement" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.action.relatedAction" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".", "id": "PlanDefinition.action.relatedAction", "isModifier": false, "isSummary": false, "max": "*", "min": 0, "path": "PlanDefinition.action.relatedAction", "short": "Relationship to another action", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PlanDefinition.action.relatedAction.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PlanDefinition.action.relatedAction.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PlanDefinition.action.relatedAction.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PlanDefinition.action.relatedAction.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "PlanDefinition.action.relatedAction.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "PlanDefinition.action.relatedAction.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "PlanDefinition.action.relatedAction.actionId" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The element id of the related action.", "id": "PlanDefinition.action.relatedAction.actionId", "isModifier": false, "isSummary": false, "max": "1", "min": 1, "path": "PlanDefinition.action.relatedAction.actionId", "short": "What action is this related to", "type": [ { "code": "id" } ] }, { "base": { "max": "1", "min": 1, "path": "PlanDefinition.action.relatedAction.relationship" }, "binding": { "description": "Defines the types of relationships between actions.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionRelationshipType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The relationship of this action to the related action.", "id": "PlanDefinition.action.relatedAction.relationship", "isModifier": false, "isSummary": false, "max": "1", "min": 1, "path": "PlanDefinition.action.relatedAction.relationship", "short": "before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.relatedAction.offset[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.", "id": "PlanDefinition.action.relatedAction.offset[x]", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.relatedAction.offset[x]", "short": "Time offset for the relationship", "type": [ { "code": "Duration" }, { "code": "Range" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.timing[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An optional value describing when the action should be performed.", "id": "PlanDefinition.action.timing[x]", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.action.timing[x]", "short": "When the action should take place", "type": [ { "code": "dateTime" }, { "code": "Age" }, { "code": "Period" }, { "code": "Duration" }, { "code": "Range" }, { "code": "Timing" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.action.participant" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates who should participate in performing the action described.", "id": "PlanDefinition.action.participant", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.participant", "short": "Who should participate in the action", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PlanDefinition.action.participant.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PlanDefinition.action.participant.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PlanDefinition.action.participant.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PlanDefinition.action.participant.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "PlanDefinition.action.participant.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "PlanDefinition.action.participant.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "PlanDefinition.action.participant.type" }, "binding": { "description": "The type of participant for the action.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionParticipantType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The type of participant in the action.", "id": "PlanDefinition.action.participant.type", "isModifier": false, "isSummary": false, "max": "1", "min": 1, "path": "PlanDefinition.action.participant.type", "short": "patient | practitioner | related-person | device", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.participant.role" }, "binding": { "description": "Defines roles played by participants for the action.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionParticipantRole" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/action-participant-role" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The role the participant should play in performing the described action.", "id": "PlanDefinition.action.participant.role", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.action.participant.role", "short": "E.g. Nurse, Surgeon, Parent", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.type" }, "binding": { "description": "The type of action to be performed.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionType" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/action-type" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The type of action to perform (create, update, remove).", "id": "PlanDefinition.action.type", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.type", "short": "create | update | remove | fire-event", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.groupingBehavior" }, "binding": { "description": "Defines organization behavior of a group.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionGroupingBehavior" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Defines the grouping behavior for the action and its children.", "id": "PlanDefinition.action.groupingBehavior", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.groupingBehavior", "short": "visual-group | logical-group | sentence-group", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.selectionBehavior" }, "binding": { "description": "Defines selection behavior of a group.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionSelectionBehavior" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Defines the selection behavior for the action and its children.", "id": "PlanDefinition.action.selectionBehavior", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.selectionBehavior", "short": "any | all | all-or-none | exactly-one | at-most-one | one-or-more", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.requiredBehavior" }, "binding": { "description": "Defines expectations around whether an action or action group is required.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionRequiredBehavior" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Defines the required behavior for the action.", "id": "PlanDefinition.action.requiredBehavior", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.requiredBehavior", "short": "must | could | must-unless-documented", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.precheckBehavior" }, "binding": { "description": "Defines selection frequency behavior for an action or group.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionPrecheckBehavior" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Defines whether the action should usually be preselected.", "id": "PlanDefinition.action.precheckBehavior", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.precheckBehavior", "short": "yes | no", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.cardinalityBehavior" }, "binding": { "description": "Defines behavior for an action or a group for how many times that item may be repeated.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionCardinalityBehavior" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Defines whether the action can be selected multiple times.", "id": "PlanDefinition.action.cardinalityBehavior", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.cardinalityBehavior", "short": "single | multiple", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.definition[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.action.definition[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Definition.derivedFrom" } ], "max": "1", "min": 0, "path": "PlanDefinition.action.definition[x]", "short": "Description of the activity to be performed", "type": [ { "code": "canonical", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ActivityDefinitionOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.transform" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.action.transform", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.transform", "short": "Transform to apply the template", "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureMap" ] } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.action.dynamicValue" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "PlanDefinition.action.dynamicValue", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "PlanDefinition.action.dynamicValue", "short": "Dynamic aspects of the definition", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "PlanDefinition.action.dynamicValue.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "PlanDefinition.action.dynamicValue.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "PlanDefinition.action.dynamicValue.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "PlanDefinition.action.dynamicValue.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "PlanDefinition.action.dynamicValue.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "PlanDefinition.action.dynamicValue.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.dynamicValue.path" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "PlanDefinition.action.dynamicValue.path", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.action.dynamicValue.path", "short": "The path to the element to be set dynamically", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "PlanDefinition.action.dynamicValue.expression" }, "comment": "The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An expression specifying the value of the customized element.", "id": "PlanDefinition.action.dynamicValue.expression", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "PlanDefinition.action.dynamicValue.expression", "short": "An expression that provides the dynamic value for the customization", "type": [ { "code": "Expression" } ] }, { "base": { "max": "*", "min": 0, "path": "PlanDefinition.action.action" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#PlanDefinition.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.", "id": "PlanDefinition.action.action", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "{InverseRelationship of Definition.partOf}" } ], "max": "0", "min": 0, "path": "PlanDefinition.action.action", "short": "A sub-action" } ] }, "status": "draft", "title": "OneHealth PlanDefinition", "type": "PlanDefinition", "url": "https://fhir.onehealth.com.pe/StructureDefinition/PlanDefinitionOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/PersonOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Person", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2023-10-30", "derivation": "constraint", "description": "FHIR PersonOH Profile, for OH interoperability scenarios, based on the national CORE Person Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Person.extension", "path": "Person.extension", "slicing": { "discriminator": [ { "path": "url", "type": "value" } ], "rules": "closed" } }, { "id": "Person.extension:Extension_mpistate", "max": "1", "min": 0, "path": "Person.extension", "short": "Patient state for MPI", "sliceName": "Extension_mpistate", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-MPIState" ] } ] }, { "definition": "Extension used in Person element to register the code of the province", "id": "Person.extension:Extension-Province", "max": "1", "min": 0, "path": "Person.extension", "short": "Address: Province code [ES: Dirección: Código de la Provincia]", "sliceName": "Extension-Province", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-province" ] } ] }, { "definition": "Extension used in Person element to register the code of the district", "id": "Person.extension:Extension-District", "max": "1", "min": 0, "path": "Person.extension", "short": "Address: District code [ES: Dirección: Código del Distrito]", "sliceName": "Extension-District", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-district" ] } ] }, { "definition": "Extension used in Person element to register the code of the department", "id": "Person.extension:Extension-Department", "max": "1", "min": 0, "path": "Person.extension", "short": "Address: Department code [ES: Dirección: Código del Departamento]", "sliceName": "Extension-Department", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-department" ] } ] }, { "definition": "Person family name [ES: apellido familiar de la Persona]", "id": "Person.identifier", "label": "Identificación", "min": 1, "path": "Person.identifier", "short": "Identifiers of the person. [ES: identificación de la Persona]", "slicing": { "description": "Types of patient identifiers.", "discriminator": [ { "path": "id", "type": "pattern" } ], "rules": "closed" } }, { "id": "Person.identifier:NationalPersonIdentifier", "max": "1", "min": 0, "path": "Person.identifier", "sliceName": "NationalPersonIdentifier" }, { "id": "Person.identifier:NationalPersonIdentifier.id", "min": 1, "path": "Person.identifier.id", "patternString": "NationalPersonIdentifier-0" }, { "id": "Person.identifier:NationalPersonIdentifier.type", "min": 1, "path": "Person.identifier.type" }, { "id": "Person.identifier:NationalPersonIdentifier.type.coding", "max": "2", "min": 2, "path": "Person.identifier.type.coding", "slicing": { "description": "International coding and synonym (or equivalent) in Peru coding", "discriminator": [ { "path": "system", "type": "value" } ], "rules": "open" } }, { "id": "Person.identifier:NationalPersonIdentifier.type.coding:InternationalCode", "max": "1", "min": 1, "path": "Person.identifier.type.coding", "sliceName": "InternationalCode" }, { "definition": "International code system of identifiers for persons. [ES: Codificación internacional de identificaciones para personas (Ej: NNPER = Identificador Nacional de Persona Peruano | PPN = Pasaporte)]", "fixedUri": "http://terminology.hl7.org/CodeSystem/v2-0203", "id": "Person.identifier:NationalPersonIdentifier.type.coding:InternationalCode.system", "min": 1, "path": "Person.identifier.type.coding.system", "short": "International code system" }, { "id": "Person.identifier:NationalPersonIdentifier.type.coding:InternationalCode.version", "max": "0", "path": "Person.identifier.type.coding.version" }, { "id": "Person.identifier:NationalPersonIdentifier.type.coding:InternationalCode.code", "min": 1, "path": "Person.identifier.type.coding.code" }, { "id": "Person.identifier:NationalPersonIdentifier.type.coding:InternationalCode.display", "max": "0", "path": "Person.identifier.type.coding.display" }, { "id": "Person.identifier:NationalPersonIdentifier.type.coding:InternationalCode.userSelected", "max": "0", "path": "Person.identifier.type.coding.userSelected" }, { "id": "Person.identifier:NationalPersonIdentifier.type.coding:PeruCode", "max": "1", "min": 1, "path": "Person.identifier.type.coding", "sliceName": "PeruCode" }, { "id": "Person.identifier:NationalPersonIdentifier.type.coding:PeruCode.system", "min": 1, "path": "Person.identifier.type.coding.system", "patternUri": "https://fhir.onehealth.com.pe/CodeSystem/PeruPersonIdentifiersOH" }, { "id": "Person.identifier:NationalPersonIdentifier.type.coding:PeruCode.version", "max": "0", "path": "Person.identifier.type.coding.version" }, { "id": "Person.identifier:NationalPersonIdentifier.type.coding:PeruCode.code", "min": 1, "path": "Person.identifier.type.coding.code", "short": "code : 1 = 'DNI' | 2 = 'Carnet de extranjería' | 3 = 'Pasaporte' | 4 = 'Documento de Identidad Extranjero' | 5 = ' Código Unico de Identificación (CUI) en Acta de Nacimiento' | 6 = 'Código Nacido Vivo (CNV)' | 7 = 'Sin Documento de Identidad'" }, { "id": "Person.identifier:NationalPersonIdentifier.type.coding:PeruCode.display", "min": 1, "path": "Person.identifier.type.coding.display" }, { "id": "Person.identifier:NationalPersonIdentifier.type.coding:PeruCode.userSelected", "max": "0", "path": "Person.identifier.type.coding.userSelected" }, { "id": "Person.identifier:NationalPersonIdentifier.type.text", "max": "0", "path": "Person.identifier.type.text" }, { "id": "Person.identifier:NationalPersonIdentifier.system", "path": "Person.identifier.system", "patternUri": "http://www.onehealth.com/reniec" }, { "definition": "Value of the Peru identification document. [ES: Valor del documento de identificación peruano]", "id": "Person.identifier:NationalPersonIdentifier.value", "label": "Número de identificación", "min": 1, "path": "Person.identifier.value", "short": "Identifier value" }, { "definition": "Period of validity of the identifier. [ES: Periódo de vigencia de la identificación]", "id": "Person.identifier:NationalPersonIdentifier.period", "label": "Vigencia", "path": "Person.identifier.period", "short": "Period of validity" }, { "definition": "Date of issuance of the identifier. [ES: Fecha de expedición de la identificación]", "id": "Person.identifier:NationalPersonIdentifier.period.start", "label": "Fecha de expedición", "min": 1, "path": "Person.identifier.period.start", "short": "Date of issuance" }, { "definition": "Identifier expiration date. [ES: Fecha de vencimiento de la identificación]", "id": "Person.identifier:NationalPersonIdentifier.period.end", "label": "Fecha de vencimiento", "path": "Person.identifier.period.end", "short": "Expiration date" }, { "id": "Person.identifier:NationalPersonIdentifier.assigner", "path": "Person.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "definition": "Person medical record number, assigned by each of the provider organizations where he/she receives health care services. [ES: Número de historia clínica del paciente, asignado por cada una de las organizaciones prestadoras donde recibe servicios de atención en salud.]", "id": "Person.identifier:PersonMedicalRecordNumber", "label": "Historia Clínica", "max": "*", "min": 0, "path": "Person.identifier", "short": "Person Medical Record Number", "sliceName": "PersonMedicalRecordNumber" }, { "id": "Person.identifier:PersonMedicalRecordNumber.id", "min": 1, "path": "Person.identifier.id", "patternString": "PatientMedicalRecordNumber-0" }, { "id": "Person.identifier:PersonMedicalRecordNumber.use", "min": 1, "path": "Person.identifier.use", "patternCode": "usual" }, { "id": "Person.identifier:PersonMedicalRecordNumber.type", "min": 1, "path": "Person.identifier.type" }, { "id": "Person.identifier:PersonMedicalRecordNumber.type.coding", "max": "1", "min": 1, "path": "Person.identifier.type.coding" }, { "id": "Person.identifier:PersonMedicalRecordNumber.type.coding.system", "min": 1, "path": "Person.identifier.type.coding.system", "patternUri": "http://terminology.hl7.org/CodeSystem/v2-0203" }, { "id": "Person.identifier:PersonMedicalRecordNumber.type.coding.version", "max": "0", "path": "Person.identifier.type.coding.version" }, { "id": "Person.identifier:PersonMedicalRecordNumber.type.coding.code", "min": 1, "path": "Person.identifier.type.coding.code", "patternCode": "MR" }, { "id": "Person.identifier:PersonMedicalRecordNumber.type.coding.display", "min": 1, "path": "Person.identifier.type.coding.display", "patternString": "Medical record number" }, { "id": "Person.identifier:PersonMedicalRecordNumber.type.coding.userSelected", "max": "0", "path": "Person.identifier.type.coding.userSelected" }, { "id": "Person.identifier:PersonMedicalRecordNumber.type.text", "max": "0", "path": "Person.identifier.type.text" }, { "definition": "Uniform Resource Identifier (URI) from the medical record information system of the provider organization (hospital, clinic, diagnostic center, etc.) that assigns the identification. [ES: Debe indicarse en este campo el sistema del cual proviene la el identificador del paciente(Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)]", "id": "Person.identifier:PersonMedicalRecordNumber.system", "label": "Sistema de Información de Historia Clínica", "path": "Person.identifier.system", "short": "Medical Record Information System [ES: Debe indicarse en este campo el sistema del cual proviene la el identificador del paciente(Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)]" }, { "definition": "Value of the patient's medical record number. [ES: Número de historia clínica del paciente]", "id": "Person.identifier:PersonMedicalRecordNumber.value", "label": "Número Historia Clínica", "min": 1, "path": "Person.identifier.value", "short": "Medical record number value" }, { "id": "Person.identifier:PersonMedicalRecordNumber.period", "max": "0", "path": "Person.identifier.period" }, { "id": "Person.identifier:PersonMedicalRecordNumber.assigner", "min": 1, "path": "Person.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Person.name", "min": 1, "path": "Person.name" }, { "id": "Person.name.use", "min": 1, "path": "Person.name.use" }, { "id": "Person.name.text", "min": 1, "path": "Person.name.text" }, { "id": "Person.name.family", "label": "Apellidos", "min": 1, "path": "Person.name.family", "short": "Person family name [ES: apellido familiar de la Persona]" }, { "id": "Person.name.family.extension", "path": "Person.name.family.extension", "slicing": { "discriminator": [ { "path": "url", "type": "value" } ], "ordered": false, "rules": "open" } }, { "id": "Person.name.family.extension:FathersFamilyName", "max": "1", "min": 0, "path": "Person.name.family.extension", "short": "fathers family name", "sliceName": "FathersFamilyName", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-FathersFamilyName" ] } ] }, { "id": "Person.name.family.extension:MothersFamilyName", "max": "1", "min": 0, "path": "Person.name.family.extension", "short": "mothers family name", "sliceName": "MothersFamilyName", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-MothersFamilyName" ] } ] }, { "id": "Person.name.given", "max": "1", "min": 1, "path": "Person.name.given" }, { "id": "Person.name.prefix", "max": "0", "path": "Person.name.prefix" }, { "id": "Person.name.suffix", "max": "0", "path": "Person.name.suffix" }, { "id": "Person.name.period", "max": "0", "path": "Person.name.period" }, { "id": "Person.telecom.system", "min": 1, "path": "Person.telecom.system" }, { "id": "Person.telecom.value", "min": 1, "path": "Person.telecom.value" }, { "id": "Person.telecom.period", "max": "0", "path": "Person.telecom.period" }, { "id": "Person.gender", "min": 1, "path": "Person.gender" }, { "id": "Person.birthDate", "min": 1, "path": "Person.birthDate" }, { "definition": "An address for the individual. [ES: Una dirección de la persona]", "id": "Person.address", "label": "Dirección", "path": "Person.address", "short": "An address for the individual" }, { "id": "Person.address.type", "min": 1, "path": "Person.address.type", "patternCode": "physical" }, { "id": "Person.address.text", "min": 1, "path": "Person.address.text" }, { "id": "Person.address.line", "max": "1", "path": "Person.address.line" }, { "id": "Person.address.city", "label": "País (ISO 3166 - código de 3 letras)", "max": "0", "path": "Person.address.city" }, { "id": "Person.address.district", "max": "0", "path": "Person.address.district" }, { "id": "Person.address.state", "max": "0", "path": "Person.address.state" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/iso3166-1-3" }, "id": "Person.address.country", "min": 1, "path": "Person.address.country", "short": "Country (ISO 3166 Part 1 3-letter codes)" }, { "id": "Person.address.period", "max": "0", "path": "Person.address.period" }, { "id": "Person.photo", "max": "0", "path": "Person.photo" }, { "id": "Person.managingOrganization", "min": 1, "path": "Person.managingOrganization", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Person.active", "min": 1, "path": "Person.active" }, { "id": "Person.link", "min": 1, "path": "Person.link" }, { "id": "Person.link.target", "path": "Person.link.target", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/PersonOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH" ] } ] } ] }, "fhirVersion": "4.0.1", "id": "PersonOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" } ], "meta": { "lastUpdated": "2024-04-12T17:46:26.747006+00:00", "versionId": "MTcxMjk0Mzk4Njc0NzAwNjAwMA" }, "name": "PersonOH", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Person" }, "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).", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "Demographics and administrative information about a person independent of a specific health-related context.", "id": "Person", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Person(classCode=\"PSN\" and determinerCode=\"INST\" and quantity=\"1\")" } ], "max": "*", "min": 0, "path": "Person", "short": "A generic person record" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Person.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Person.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Person.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Person.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Person.implicitRules", "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, "max": "1", "min": 0, "path": "Person.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Person.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Person.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Person.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Person.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Person.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Person.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Person.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Person.extension", "short": "Additional content defined by implementations", "slicing": { "discriminator": [ { "path": "url", "type": "value" } ], "rules": "closed" }, "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Person.extension:Extension_mpistate", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Person.extension", "short": "Patient state for MPI", "sliceName": "Extension_mpistate", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-MPIState" ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "definition": "Extension used in Person element to register the code of the province", "id": "Person.extension:Extension-Province", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Person.extension", "short": "Address: Province code [ES: Dirección: Código de la Provincia]", "sliceName": "Extension-Province", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-province" ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "definition": "Extension used in Person element to register the code of the district", "id": "Person.extension:Extension-District", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Person.extension", "short": "Address: District code [ES: Dirección: Código del Distrito]", "sliceName": "Extension-District", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-district" ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "definition": "Extension used in Person element to register the code of the department", "id": "Person.extension:Extension-Department", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Person.extension", "short": "Address: Department code [ES: Dirección: Código del Departamento]", "sliceName": "Extension-Department", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-department" ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Person.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Person.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Person.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Person family name [ES: apellido familiar de la Persona]", "id": "Person.identifier", "isModifier": false, "isSummary": false, "label": "Identificación", "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": ".plays:Role(classCode='IDENT').id" } ], "max": "*", "min": 1, "path": "Person.identifier", "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.", "short": "Identifiers of the person. [ES: identificación de la Persona]", "slicing": { "description": "Types of patient identifiers.", "discriminator": [ { "path": "id", "type": "pattern" } ], "rules": "closed" }, "type": [ { "code": "Identifier" } ] }, { "base": { "max": "*", "min": 0, "path": "Person.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifiers of the persona. [ES: identificación de la Persona]", "id": "Person.identifier:NationalPersonIdentifier", "isModifier": false, "isSummary": false, "label": "Identificación", "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": ".plays:Role(classCode='IDENT').id" } ], "max": "1", "min": 0, "path": "Person.identifier", "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.", "short": "Identifiers of the person. [ES: identificación de la Persona]", "sliceName": "NationalPersonIdentifier", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Person.identifier:NationalPersonIdentifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Person.identifier.id", "patternString": "NationalPersonIdentifier-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Person.identifier:NationalPersonIdentifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Person.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "Person.identifier:NationalPersonIdentifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 0, "path": "Person.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "Person.identifier:NationalPersonIdentifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "Person.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Person.identifier:NationalPersonIdentifier.type.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Person.identifier.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Person.identifier:NationalPersonIdentifier.type.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Person.identifier.type.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Person.identifier:NationalPersonIdentifier.type.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "2", "min": 2, "path": "Person.identifier.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "slicing": { "description": "International coding and synonym (or equivalent) in Peru coding", "discriminator": [ { "path": "system", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Coding" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Person.identifier:NationalPersonIdentifier.type.coding:InternationalCode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Person.identifier.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "sliceName": "InternationalCode", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Person.identifier:NationalPersonIdentifier.type.coding:InternationalCode.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Person.identifier.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Person.identifier:NationalPersonIdentifier.type.coding:InternationalCode.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Person.identifier.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "International code system of identifiers for persons. [ES: Codificación internacional de identificaciones para personas (Ej: NNPER = Identificador Nacional de Persona Peruano | PPN = Pasaporte)]", "fixedUri": "http://terminology.hl7.org/CodeSystem/v2-0203", "id": "Person.identifier:NationalPersonIdentifier.type.coding:InternationalCode.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Person.identifier.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "International code system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Person.identifier:NationalPersonIdentifier.type.coding:InternationalCode.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Person.identifier.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Person.identifier:NationalPersonIdentifier.type.coding:InternationalCode.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Person.identifier.type.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Person.identifier:NationalPersonIdentifier.type.coding:InternationalCode.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "0", "min": 0, "path": "Person.identifier.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Person.identifier:NationalPersonIdentifier.type.coding:InternationalCode.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Person.identifier.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Person.identifier:NationalPersonIdentifier.type.coding:PeruCode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Person.identifier.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "sliceName": "PeruCode", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Person.identifier:NationalPersonIdentifier.type.coding:PeruCode.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Person.identifier.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Person.identifier:NationalPersonIdentifier.type.coding:PeruCode.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Person.identifier.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Person.identifier:NationalPersonIdentifier.type.coding:PeruCode.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Person.identifier.type.coding.system", "patternUri": "https://fhir.onehealth.com.pe/CodeSystem/PeruPersonIdentifiersOH", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Person.identifier:NationalPersonIdentifier.type.coding:PeruCode.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Person.identifier.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Person.identifier:NationalPersonIdentifier.type.coding:PeruCode.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Person.identifier.type.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "code : 1 = 'DNI' | 2 = 'Carnet de extranjería' | 3 = 'Pasaporte' | 4 = 'Documento de Identidad Extranjero' | 5 = ' Código Unico de Identificación (CUI) en Acta de Nacimiento' | 6 = 'Código Nacido Vivo (CNV)' | 7 = 'Sin Documento de Identidad'", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Person.identifier:NationalPersonIdentifier.type.coding:PeruCode.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Person.identifier.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Person.identifier:NationalPersonIdentifier.type.coding:PeruCode.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Person.identifier.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Person.identifier:NationalPersonIdentifier.type.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Person.identifier.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "Person.identifier:NationalPersonIdentifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 0, "path": "Person.identifier.system", "patternUri": "http://www.onehealth.com/reniec", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Value of the Peru identification document. [ES: Valor del documento de identificación peruano]", "example": [ { "label": "General", "valueString": "123456" } ], "id": "Person.identifier:NationalPersonIdentifier.value", "isModifier": false, "isSummary": true, "label": "Número de identificación", "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Person.identifier.value", "short": "Identifier value", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Period of validity of the identifier. [ES: Periódo de vigencia de la identificación]", "id": "Person.identifier:NationalPersonIdentifier.period", "isModifier": false, "isSummary": true, "label": "Vigencia", "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "1", "min": 0, "path": "Person.identifier.period", "short": "Period of validity", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Person.identifier:NationalPersonIdentifier.period.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Person.identifier.period.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Person.identifier:NationalPersonIdentifier.period.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Person.identifier.period.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.start" }, "comment": "If the low element is missing, the meaning is that the low boundary is not known.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Date of issuance of the identifier. [ES: Fecha de expedición de la identificación]", "id": "Person.identifier:NationalPersonIdentifier.period.start", "isModifier": false, "isSummary": true, "label": "Fecha de expedición", "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ], "max": "1", "min": 1, "path": "Person.identifier.period.start", "short": "Date of issuance", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.end" }, "comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifier expiration date. [ES: Fecha de vencimiento de la identificación]", "id": "Person.identifier:NationalPersonIdentifier.period.end", "isModifier": false, "isSummary": true, "label": "Fecha de vencimiento", "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ], "max": "1", "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "min": 0, "path": "Person.identifier.period.end", "short": "Expiration date", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "Person.identifier:NationalPersonIdentifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 0, "path": "Person.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Person.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Person medical record number, assigned by each of the provider organizations where he/she receives health care services. [ES: Número de historia clínica del paciente, asignado por cada una de las organizaciones prestadoras donde recibe servicios de atención en salud.]", "id": "Person.identifier:PersonMedicalRecordNumber", "isModifier": false, "isSummary": false, "label": "Historia Clínica", "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": ".plays:Role(classCode='IDENT').id" } ], "max": "*", "min": 0, "path": "Person.identifier", "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.", "short": "Person Medical Record Number", "sliceName": "PersonMedicalRecordNumber", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Person.identifier:PersonMedicalRecordNumber.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Person.identifier.id", "patternString": "PatientMedicalRecordNumber-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Person.identifier:PersonMedicalRecordNumber.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Person.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "Person.identifier:PersonMedicalRecordNumber.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "Person.identifier.use", "patternCode": "usual", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "Person.identifier:PersonMedicalRecordNumber.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "Person.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Person.identifier:PersonMedicalRecordNumber.type.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Person.identifier.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Person.identifier:PersonMedicalRecordNumber.type.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Person.identifier.type.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Person.identifier:PersonMedicalRecordNumber.type.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Person.identifier.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Person.identifier:PersonMedicalRecordNumber.type.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Person.identifier.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Person.identifier:PersonMedicalRecordNumber.type.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Person.identifier.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Person.identifier:PersonMedicalRecordNumber.type.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Person.identifier.type.coding.system", "patternUri": "http://terminology.hl7.org/CodeSystem/v2-0203", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Person.identifier:PersonMedicalRecordNumber.type.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Person.identifier.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Person.identifier:PersonMedicalRecordNumber.type.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Person.identifier.type.coding.code", "patternCode": "MR", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Person.identifier:PersonMedicalRecordNumber.type.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Person.identifier.type.coding.display", "patternString": "Medical record number", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Person.identifier:PersonMedicalRecordNumber.type.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Person.identifier.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Person.identifier:PersonMedicalRecordNumber.type.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Person.identifier.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Uniform Resource Identifier (URI) from the medical record information system of the provider organization (hospital, clinic, diagnostic center, etc.) that assigns the identification. [ES: Debe indicarse en este campo el sistema del cual proviene la el identificador del paciente(Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)]", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "Person.identifier:PersonMedicalRecordNumber.system", "isModifier": false, "isSummary": true, "label": "Sistema de Información de Historia Clínica", "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 0, "path": "Person.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "Medical Record Information System [ES: Debe indicarse en este campo el sistema del cual proviene la el identificador del paciente(Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)]", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Value of the patient's medical record number. [ES: Número de historia clínica del paciente]", "example": [ { "label": "General", "valueString": "123456" } ], "id": "Person.identifier:PersonMedicalRecordNumber.value", "isModifier": false, "isSummary": true, "label": "Número Historia Clínica", "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Person.identifier.value", "short": "Medical record number value", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "Person.identifier:PersonMedicalRecordNumber.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Person.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "Person.identifier:PersonMedicalRecordNumber.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 1, "path": "Person.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Person.name" }, "comment": "Person may have multiple names with different uses or applicable periods.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A name associated with the person.", "id": "Person.name", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-5, PID-9" }, { "identity": "rim", "map": "./name" } ], "max": "*", "min": 1, "path": "Person.name", "requirements": "Need to be able to track the person by multiple names. Examples are your official name and a partner name.", "short": "A name associated with the person", "type": [ { "code": "HumanName" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Person.name.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Person.name.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Person.name.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Person.name.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "HumanName.use" }, "binding": { "description": "The use of a human name.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "NameUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/name-use|4.0.1" }, "comment": "Applications can assume that a name is current unless it explicitly says that it is temporary or old.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the purpose for this name.", "id": "Person.name.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.7, but often indicated by which field contains the name" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./NamePurpose" } ], "max": "1", "min": 1, "path": "Person.name.use", "requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.", "short": "usual | official | temp | nickname | anonymous | old | maiden", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "HumanName.text" }, "comment": "Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.", "id": "Person.name.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "implied by XPN.11" }, { "identity": "rim", "map": "./formatted" } ], "max": "1", "min": 1, "path": "Person.name.text", "requirements": "A renderable, unencoded form.", "short": "Text representation of the full name", "type": [ { "code": "string" } ] }, { "alias": [ "surname" ], "base": { "max": "1", "min": 0, "path": "HumanName.family" }, "comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.", "id": "Person.name.family", "isModifier": false, "isSummary": true, "label": "Apellidos", "mapping": [ { "identity": "v2", "map": "XPN.1/FN.1" }, { "identity": "rim", "map": "./part[partType = FAM]" }, { "identity": "servd", "map": "./FamilyName" } ], "max": "1", "min": 1, "path": "Person.name.family", "short": "Person family name [ES: apellido familiar de la Persona]", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "unique id for the element within a resource (for internal references)", "id": "Person.name.family.id", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Person.name.family.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "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.", "id": "Person.name.family.extension", "isModifier": false, "isSummary": false, "max": "*", "min": 0, "path": "Person.name.family.extension", "short": "Additional content defined by implementations", "slicing": { "discriminator": [ { "path": "url", "type": "value" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "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.", "id": "Person.name.family.extension:FathersFamilyName", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Person.name.family.extension", "short": "fathers family name", "sliceName": "FathersFamilyName", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-FathersFamilyName" ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "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.", "id": "Person.name.family.extension:MothersFamilyName", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Person.name.family.extension", "short": "mothers family name", "sliceName": "MothersFamilyName", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-MothersFamilyName" ] } ] }, { "base": { "max": "1", "min": 0, "path": "string.value" }, "definition": "The actual value", "id": "Person.name.family.value", "isModifier": false, "isSummary": false, "max": "1", "maxLength": 1048576, "min": 0, "path": "Person.name.family.value", "representation": [ "xmlAttr" ], "short": "Primitive value for string", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" }, { "url": "http://hl7.org/fhir/StructureDefinition/regex", "valueString": "[ \\r\\n\\t\\S]+" } ] } ] }, { "alias": [ "first name", "middle name" ], "base": { "max": "*", "min": 0, "path": "HumanName.given" }, "comment": "If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called \"first name\" since given names do not always come first.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Given name.", "id": "Person.name.given", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.2 + XPN.3" }, { "identity": "rim", "map": "./part[partType = GIV]" }, { "identity": "servd", "map": "./GivenNames" } ], "max": "1", "min": 1, "orderMeaning": "Given Names appear in the correct order for presenting the name", "path": "Person.name.given", "short": "Given names (not always 'first'). Includes middle names", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "HumanName.prefix" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.", "id": "Person.name.prefix", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.5" }, { "identity": "rim", "map": "./part[partType = PFX]" }, { "identity": "servd", "map": "./TitleCode" } ], "max": "0", "min": 0, "orderMeaning": "Prefixes appear in the correct order for presenting the name", "path": "Person.name.prefix", "short": "Parts that come before the name", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "HumanName.suffix" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.", "id": "Person.name.suffix", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN/4" }, { "identity": "rim", "map": "./part[partType = SFX]" } ], "max": "0", "min": 0, "orderMeaning": "Suffixes appear in the correct order for presenting the name", "path": "Person.name.suffix", "short": "Parts that come after the name", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "HumanName.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the period of time when this name was valid for the named person.", "id": "Person.name.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.13 + XPN.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Person.name.period", "requirements": "Allows names to be placed in historical context.", "short": "Time period when name was/is in use", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "Person.telecom" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A contact detail for the person, e.g. a telephone number or an email address.", "id": "Person.telecom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-13, PID-14" }, { "identity": "rim", "map": "./telecom" } ], "max": "*", "min": 0, "path": "Person.telecom", "requirements": "People have (primary) ways to contact them in some way such as phone, email.", "short": "A contact detail for the person", "type": [ { "code": "ContactPoint" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Person.telecom.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Person.telecom.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Person.telecom.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Person.telecom.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.system" }, "binding": { "description": "Telecommunications form for contact point.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPointSystem" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1" }, "condition": [ "cpt-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.", "id": "Person.telecom.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.3" }, { "identity": "rim", "map": "./scheme" }, { "identity": "servd", "map": "./ContactPointType" } ], "max": "1", "min": 1, "path": "Person.telecom.system", "short": "phone | fax | email | pager | url | sms | other", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.value" }, "comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).", "id": "Person.telecom.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.1 (or XTN.12)" }, { "identity": "rim", "map": "./url" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Person.telecom.value", "requirements": "Need to support legacy numbers that are not in a tightly controlled format.", "short": "The actual contact point details", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.use" }, "binding": { "description": "Use of contact point.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPointUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1" }, "comment": "Applications can assume that a contact is current unless it explicitly says that it is temporary or old.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the purpose for the contact point.", "id": "Person.telecom.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.2 - but often indicated by field" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./ContactPointPurpose" } ], "max": "1", "min": 0, "path": "Person.telecom.use", "requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.", "short": "home | work | temp | old | mobile - purpose of this contact point", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.rank" }, "comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.", "id": "Person.telecom.rank", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Person.telecom.rank", "short": "Specify preferred order of use (1 = highest)", "type": [ { "code": "positiveInt" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period when the contact point was/is in use.", "id": "Person.telecom.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Person.telecom.period", "short": "Time period when the contact point was/is in use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Person.gender" }, "binding": { "description": "The gender of a person used for administrative purposes.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdministrativeGender" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Administrative Gender.", "id": "Person.gender", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-8" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender" } ], "max": "1", "min": 1, "path": "Person.gender", "requirements": "Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes.", "short": "male | female | other | unknown", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Person.birthDate" }, "comment": "At least an estimated year should be provided as a guess if the real DOB is unknown.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The birth date for the person.", "id": "Person.birthDate", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-7" }, { "identity": "rim", "map": "./birthTime" } ], "max": "1", "min": 1, "path": "Person.birthDate", "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.", "short": "The date on which the person was born", "type": [ { "code": "date" } ] }, { "base": { "max": "*", "min": 0, "path": "Person.address" }, "comment": "Person may have multiple addresses with different uses or applicable periods.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An address for the individual. [ES: Una dirección de la persona]", "id": "Person.address", "isModifier": false, "isSummary": false, "label": "Dirección", "mapping": [ { "identity": "v2", "map": "PID-11" }, { "identity": "rim", "map": "./addr" } ], "max": "*", "min": 0, "path": "Person.address", "requirements": "May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification.", "short": "An address for the individual", "type": [ { "code": "Address" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Person.address.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Person.address.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Person.address.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Person.address.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.use" }, "binding": { "description": "The use of an address.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/address-use|4.0.1" }, "comment": "Applications can assume that an address is current unless it explicitly says that it is temporary or old.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this address.", "example": [ { "label": "General", "valueCode": "home" } ], "id": "Person.address.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.7" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./AddressPurpose" } ], "max": "1", "min": 0, "path": "Person.address.use", "requirements": "Allows an appropriate address to be chosen from a list of many.", "short": "home | work | temp | old | billing - purpose of this address", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.type" }, "binding": { "description": "The type of an address (physical / postal).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/address-type|4.0.1" }, "comment": "The definition of Address states that \"address is intended to describe postal addresses, not physical locations\". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](location.html#) resource).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.", "example": [ { "label": "General", "valueCode": "both" } ], "id": "Person.address.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.18" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "vcard", "map": "address type parameter" } ], "max": "1", "min": 1, "path": "Person.address.type", "patternCode": "physical", "short": "postal | physical | both", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.text" }, "comment": "Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.", "example": [ { "label": "General", "valueString": "137 Nowhere Street, Erewhon 9132" } ], "id": "Person.address.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6" }, { "identity": "rim", "map": "./formatted" }, { "identity": "vcard", "map": "address label parameter" } ], "max": "1", "min": 1, "path": "Person.address.text", "requirements": "A renderable, unencoded form.", "short": "Text representation of the address", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Address.line" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.", "example": [ { "label": "General", "valueString": "137 Nowhere Street" } ], "id": "Person.address.line", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "vcard", "map": "street" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ], "max": "1", "min": 0, "orderMeaning": "The order in which lines should appear in an address label", "path": "Person.address.line", "short": "Street name, number, direction & P.O. Box etc.", "type": [ { "code": "string" } ] }, { "alias": [ "Municpality" ], "base": { "max": "1", "min": 0, "path": "Address.city" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The name of the city, town, suburb, village or other community or delivery center.", "example": [ { "label": "General", "valueString": "Erewhon" } ], "id": "Person.address.city", "isModifier": false, "isSummary": true, "label": "País (ISO 3166 - código de 3 letras)", "mapping": [ { "identity": "v2", "map": "XAD.3" }, { "identity": "rim", "map": "AD.part[parttype = CTY]" }, { "identity": "vcard", "map": "locality" }, { "identity": "servd", "map": "./Jurisdiction" } ], "max": "0", "min": 0, "path": "Person.address.city", "short": "Name of city, town etc.", "type": [ { "code": "string" } ] }, { "alias": [ "County" ], "base": { "max": "1", "min": 0, "path": "Address.district" }, "comment": "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The name of the administrative area (county).", "example": [ { "label": "General", "valueString": "Madison" } ], "id": "Person.address.district", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.9" }, { "identity": "rim", "map": "AD.part[parttype = CNT | CPA]" } ], "max": "0", "min": 0, "path": "Person.address.district", "short": "District name (aka county)", "type": [ { "code": "string" } ] }, { "alias": [ "Province", "Territory" ], "base": { "max": "1", "min": 0, "path": "Address.state" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).", "id": "Person.address.state", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.4" }, { "identity": "rim", "map": "AD.part[parttype = STA]" }, { "identity": "vcard", "map": "region" }, { "identity": "servd", "map": "./Region" } ], "max": "0", "min": 0, "path": "Person.address.state", "short": "Sub-unit of country (abbreviations ok)", "type": [ { "code": "string" } ] }, { "alias": [ "Zip" ], "base": { "max": "1", "min": 0, "path": "Address.postalCode" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A postal code designating a region defined by the postal service.", "example": [ { "label": "General", "valueString": "9132" } ], "id": "Person.address.postalCode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.5" }, { "identity": "rim", "map": "AD.part[parttype = ZIP]" }, { "identity": "vcard", "map": "code" }, { "identity": "servd", "map": "./PostalIdentificationCode" } ], "max": "1", "min": 0, "path": "Person.address.postalCode", "short": "Postal code for area", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.country" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/iso3166-1-3" }, "comment": "ISO 3166 3 letter codes can be used in place of a human readable country name.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Country - a nation as commonly understood or generally accepted.", "id": "Person.address.country", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.6" }, { "identity": "rim", "map": "AD.part[parttype = CNT]" }, { "identity": "vcard", "map": "country" }, { "identity": "servd", "map": "./Country" } ], "max": "1", "min": 1, "path": "Person.address.country", "short": "Country (ISO 3166 Part 1 3-letter codes)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period when address was/is in use.", "example": [ { "label": "General", "valuePeriod": { "end": "2010-07-01", "start": "2010-03-23" } } ], "id": "Person.address.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.12 / XAD.13 + XAD.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Person.address.period", "requirements": "Allows addresses to be placed in historical context.", "short": "Time period when address was/is in use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Person.photo" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.", "id": "Person.photo", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-5 - needs a profile" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc" } ], "max": "0", "min": 0, "path": "Person.photo", "short": "Image of the person", "type": [ { "code": "Attachment" } ] }, { "base": { "max": "1", "min": 0, "path": "Person.managingOrganization" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The organization that is the custodian of the person record.", "id": "Person.managingOrganization", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "scoper" } ], "max": "1", "min": 1, "path": "Person.managingOrganization", "requirements": "Need to know who recognizes this person record, manages and updates it.", "short": "The organization that is the custodian of the person record", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Person.active" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Whether this person's record is in active use.", "id": "Person.active", "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" } ], "max": "1", "min": 1, "path": "Person.active", "requirements": "Need to be able to mark a person record as not to be used because it was created in error.", "short": "This person's record is in active use", "type": [ { "code": "boolean" } ] }, { "base": { "max": "*", "min": 0, "path": "Person.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Link to a resource that concerns the same actual person.", "id": "Person.link", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "outboundLink" } ], "max": "*", "min": 1, "path": "Person.link", "short": "Link to a resource that concerns the same actual person", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Person.link.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Person.link.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Person.link.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Person.link.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Person.link.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Person.link.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Person.link.target" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The resource to which this actual person is associated.", "id": "Person.link.target", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "id" } ], "max": "1", "min": 1, "path": "Person.link.target", "short": "The resource to which this actual person is associated", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/PersonOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Person.link.assurance" }, "binding": { "description": "The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentityAssuranceLevel" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identity-assuranceLevel|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Level of assurance that this link is associated with the target resource.", "id": "Person.link.assurance", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "priorityNumber?" } ], "max": "1", "min": 0, "path": "Person.link.assurance", "short": "level1 | level2 | level3 | level4", "type": [ { "code": "code" } ] } ] }, "status": "draft", "title": "OneHealth Person", "type": "Person", "url": "https://fhir.onehealth.com.pe/StructureDefinition/PersonOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/PatientOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2023-12-05", "derivation": "constraint", "description": "FHIR PatientOH Profile, for OH interoperability scenarios, based on the national CORE Patient Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Patient.extension", "path": "Patient.extension", "slicing": { "discriminator": [ { "path": "url", "type": "value" } ], "ordered": false, "rules": "open" } }, { "id": "Patient.extension:Extension-Classification", "max": "1", "min": 0, "path": "Patient.extension", "short": "Patient classification", "sliceName": "Extension-Classification", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-Classification" ] } ] }, { "id": "Patient.extension:Extension-Religion", "max": "1", "min": 0, "path": "Patient.extension", "short": "Patient religion", "sliceName": "Extension-Religion", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-Religion" ] } ] }, { "definition": "Patient medical record number, assigned by each of the provider organizations where he/she receives health care services. [ES: Número de historia clínica del paciente, asignado por cada una de las organizaciones prestadoras donde recibe servicios de atención en salud.]", "id": "Patient.identifier", "label": "Historia Clínica", "min": 1, "path": "Patient.identifier", "short": "Patient Medical Record Number" }, { "id": "Patient.identifier.use", "min": 1, "path": "Patient.identifier.use", "patternCode": "official" }, { "id": "Patient.identifier.type", "min": 1, "path": "Patient.identifier.type" }, { "id": "Patient.identifier.type.coding", "max": "1", "min": 1, "path": "Patient.identifier.type.coding" }, { "id": "Patient.identifier.type.coding.system", "min": 1, "path": "Patient.identifier.type.coding.system" }, { "id": "Patient.identifier.type.coding.version", "max": "0", "path": "Patient.identifier.type.coding.version" }, { "id": "Patient.identifier.type.coding.code", "min": 1, "path": "Patient.identifier.type.coding.code", "patternCode": "MR" }, { "id": "Patient.identifier.type.coding.display", "min": 1, "path": "Patient.identifier.type.coding.display", "patternString": "Medical record number" }, { "id": "Patient.identifier.type.coding.userSelected", "max": "0", "path": "Patient.identifier.type.coding.userSelected" }, { "definition": "Uniform Resource Identifier (URI) from the medical record information system of the provider organization (hospital, clinic, diagnostic center, etc.) that assigns the identification. [ES: Debe indicarse en este campo el sistema del cual proviene la el identificador del paciente(Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)]", "id": "Patient.identifier.system", "label": "Sistema de Información de Historia Clínica", "path": "Patient.identifier.system", "short": "Medical Record Information System [ES: Debe indicarse en este campo el sistema del cual proviene la el identificador del paciente(Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)]" }, { "definition": "Value of the patient's medical record number. [ES: Número de historia clínica del paciente]", "id": "Patient.identifier.value", "label": "Número Historia Clínica", "min": 1, "mustSupport": true, "path": "Patient.identifier.value", "short": "Medical record number value" }, { "id": "Patient.identifier.period", "max": "0", "path": "Patient.identifier.period" }, { "id": "Patient.identifier.assigner", "min": 1, "path": "Patient.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Patient.active", "min": 1, "path": "Patient.active" }, { "id": "Patient.name", "max": "0", "path": "Patient.name" }, { "id": "Patient.telecom", "max": "0", "path": "Patient.telecom" }, { "id": "Patient.gender", "max": "0", "path": "Patient.gender" }, { "id": "Patient.birthDate", "max": "0", "path": "Patient.birthDate" }, { "id": "Patient.deceased[x]", "path": "Patient.deceased[x]", "type": [ { "code": "dateTime" } ] }, { "id": "Patient.address", "max": "0", "path": "Patient.address" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/marital-status" }, "id": "Patient.maritalStatus", "path": "Patient.maritalStatus" }, { "id": "Patient.maritalStatus.coding", "max": "1", "min": 1, "path": "Patient.maritalStatus.coding" }, { "id": "Patient.maritalStatus.coding.system", "min": 1, "path": "Patient.maritalStatus.coding.system", "short": "Identity of the terminology system\r\n[ES: Ejemplo: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus]" }, { "id": "Patient.maritalStatus.coding.version", "max": "0", "path": "Patient.maritalStatus.coding.version" }, { "id": "Patient.maritalStatus.coding.code", "min": 1, "path": "Patient.maritalStatus.coding.code", "short": "Symbol in syntax defined by the system[ES: Ejemplo: M]" }, { "id": "Patient.maritalStatus.coding.display", "min": 1, "path": "Patient.maritalStatus.coding.display", "short": "Representation defined by the system [ES: Ejemplo: Married]" }, { "id": "Patient.maritalStatus.coding.userSelected", "max": "0", "path": "Patient.maritalStatus.coding.userSelected" }, { "id": "Patient.maritalStatus.text", "max": "0", "path": "Patient.maritalStatus.text" }, { "id": "Patient.photo", "max": "0", "path": "Patient.photo" }, { "id": "Patient.contact.relationship", "max": "1", "min": 1, "path": "Patient.contact.relationship" }, { "id": "Patient.contact.relationship.coding", "max": "1", "min": 1, "path": "Patient.contact.relationship.coding" }, { "id": "Patient.contact.relationship.coding.system", "min": 1, "path": "Patient.contact.relationship.coding.system" }, { "id": "Patient.contact.relationship.coding.version", "max": "0", "path": "Patient.contact.relationship.coding.version" }, { "id": "Patient.contact.relationship.coding.code", "min": 1, "path": "Patient.contact.relationship.coding.code" }, { "id": "Patient.contact.relationship.coding.display", "min": 1, "path": "Patient.contact.relationship.coding.display" }, { "id": "Patient.contact.relationship.coding.userSelected", "max": "0", "path": "Patient.contact.relationship.coding.userSelected" }, { "id": "Patient.contact.relationship.text", "max": "0", "path": "Patient.contact.relationship.text" }, { "id": "Patient.contact.name", "min": 1, "path": "Patient.contact.name" }, { "id": "Patient.contact.name.use", "min": 1, "path": "Patient.contact.name.use" }, { "id": "Patient.contact.name.text", "min": 1, "path": "Patient.contact.name.text" }, { "id": "Patient.contact.name.family", "label": "Apellidos", "min": 1, "path": "Patient.contact.name.family", "short": "Patient's family name" }, { "id": "Patient.contact.name.family.extension", "path": "Patient.contact.name.family.extension", "slicing": { "discriminator": [ { "path": "url", "type": "value" } ], "ordered": false, "rules": "open" } }, { "id": "Patient.contact.name.family.extension:FathersFamilyName", "max": "1", "min": 0, "path": "Patient.contact.name.family.extension", "sliceName": "FathersFamilyName", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-FathersFamilyName" ] } ] }, { "id": "Patient.contact.name.family.extension:MothersFamilyName", "max": "1", "min": 0, "path": "Patient.contact.name.family.extension", "sliceName": "MothersFamilyName", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-MothersFamilyName" ] } ] }, { "id": "Patient.contact.name.given", "max": "1", "min": 1, "path": "Patient.contact.name.given" }, { "id": "Patient.contact.name.prefix", "max": "0", "path": "Patient.contact.name.prefix" }, { "id": "Patient.contact.name.suffix", "max": "0", "path": "Patient.contact.name.suffix" }, { "id": "Patient.contact.name.period", "max": "0", "path": "Patient.contact.name.period" }, { "id": "Patient.contact.telecom.system", "min": 1, "path": "Patient.contact.telecom.system" }, { "id": "Patient.contact.telecom.value", "min": 1, "path": "Patient.contact.telecom.value" }, { "id": "Patient.contact.address.type", "min": 1, "path": "Patient.contact.address.type" }, { "id": "Patient.communication", "max": "0", "path": "Patient.communication" }, { "id": "Patient.link", "max": "0", "path": "Patient.link" } ] }, "fhirVersion": "4.0.1", "id": "PatientOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "cda", "name": "CDA (R2)", "uri": "http://hl7.org/v3/cda" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "loinc", "name": "LOINC code for the element", "uri": "http://loinc.org" } ], "meta": { "lastUpdated": "2024-04-12T17:46:26.444445+00:00", "versionId": "MTcxMjk0Mzk4NjQ0NDQ0NTAwMA" }, "name": "PatientOH", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "SubjectOfCare Client Resident" ], "base": { "max": "*", "min": 0, "path": "Patient" }, "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "Demographics and other administrative information about an individual or animal receiving care or other health-related services.", "id": "Patient", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Patient[classCode=PAT]" }, { "identity": "cda", "map": "ClinicalDocument.recordTarget.patientRole" } ], "max": "*", "min": 0, "path": "Patient", "short": "Information about an individual or animal receiving health care services" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Patient.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Patient.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Patient.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Patient.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Patient.implicitRules", "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, "max": "1", "min": 0, "path": "Patient.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Patient.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Patient.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Patient.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Patient.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Patient.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Patient.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Patient.extension", "short": "Additional content defined by implementations", "slicing": { "discriminator": [ { "path": "url", "type": "value" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.extension:Extension-Classification", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Patient.extension", "short": "Patient classification", "sliceName": "Extension-Classification", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-Classification" ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.extension:Extension-Religion", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Patient.extension", "short": "Patient religion", "sliceName": "Extension-Religion", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-Religion" ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Patient.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Patient.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Patient.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Patient medical record number, assigned by each of the provider organizations where he/she receives health care services. [ES: Número de historia clínica del paciente, asignado por cada una de las organizaciones prestadoras donde recibe servicios de atención en salud.]", "id": "Patient.identifier", "isModifier": false, "isSummary": true, "label": "Historia Clínica", "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": "id" }, { "identity": "cda", "map": ".id" } ], "max": "*", "min": 1, "path": "Patient.identifier", "requirements": "Patients are almost always assigned specific numerical identifiers.", "short": "Patient Medical Record Number", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Patient.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "Patient.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "Patient.identifier.use", "patternCode": "official", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "Patient.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "Patient.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Patient.identifier.type.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.identifier.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.identifier.type.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.identifier.type.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Patient.identifier.type.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Patient.identifier.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Patient.identifier.type.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.identifier.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.identifier.type.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.identifier.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Patient.identifier.type.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Patient.identifier.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Patient.identifier.type.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Patient.identifier.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Patient.identifier.type.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Patient.identifier.type.coding.code", "patternCode": "MR", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Patient.identifier.type.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Patient.identifier.type.coding.display", "patternString": "Medical record number", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Patient.identifier.type.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Patient.identifier.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Patient.identifier.type.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "Patient.identifier.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Uniform Resource Identifier (URI) from the medical record information system of the provider organization (hospital, clinic, diagnostic center, etc.) that assigns the identification. [ES: Debe indicarse en este campo el sistema del cual proviene la el identificador del paciente(Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)]", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "Patient.identifier.system", "isModifier": false, "isSummary": true, "label": "Sistema de Información de Historia Clínica", "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 0, "path": "Patient.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "Medical Record Information System [ES: Debe indicarse en este campo el sistema del cual proviene la el identificador del paciente(Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)]", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Value of the patient's medical record number. [ES: Número de historia clínica del paciente]", "example": [ { "label": "General", "valueString": "123456" } ], "id": "Patient.identifier.value", "isModifier": false, "isSummary": true, "label": "Número Historia Clínica", "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Patient.identifier.value", "short": "Medical record number value", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "Patient.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Patient.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "Patient.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 1, "path": "Patient.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Patient.active" }, "comment": "If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Patient.active", "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" } ], "max": "1", "meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element", "min": 1, "path": "Patient.active", "requirements": "Need to be able to mark a patient record as not to be used because it was created in error.", "short": "Whether this patient's record is in active use", "type": [ { "code": "boolean" } ] }, { "base": { "max": "*", "min": 0, "path": "Patient.name" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A name associated with the individual.", "id": "Patient.name", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-5, PID-9" }, { "identity": "rim", "map": "name" }, { "identity": "cda", "map": ".patient.name" } ], "max": "0", "min": 0, "path": "Patient.name", "requirements": "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.", "short": "A name associated with the patient", "type": [ { "code": "HumanName" } ] }, { "base": { "max": "*", "min": 0, "path": "Patient.telecom" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.", "id": "Patient.telecom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-13, PID-14, PID-40" }, { "identity": "rim", "map": "telecom" }, { "identity": "cda", "map": ".telecom" } ], "max": "0", "min": 0, "path": "Patient.telecom", "requirements": "People have (primary) ways to contact them in some way such as phone, email.", "short": "A contact detail for the individual", "type": [ { "code": "ContactPoint" } ] }, { "base": { "max": "1", "min": 0, "path": "Patient.gender" }, "binding": { "description": "The gender of a person used for administrative purposes.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdministrativeGender" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.", "id": "Patient.gender", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-8" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender" }, { "identity": "cda", "map": ".patient.administrativeGenderCode" } ], "max": "0", "min": 0, "path": "Patient.gender", "requirements": "Needed for identification of the individual, in combination with (at least) name and birth date.", "short": "male | female | other | unknown", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Patient.birthDate" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date of birth for the individual.", "id": "Patient.birthDate", "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" } ], "max": "0", "min": 0, "path": "Patient.birthDate", "requirements": "Age of the individual drives many clinical processes.", "short": "The date of birth for the individual", "type": [ { "code": "date" } ] }, { "base": { "max": "1", "min": 0, "path": "Patient.deceased[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates if the individual is deceased or not.", "id": "Patient.deceased[x]", "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" } ], "max": "1", "min": 0, "path": "Patient.deceased[x]", "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.", "short": "Indicates if the individual is deceased or not", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "*", "min": 0, "path": "Patient.address" }, "comment": "Patient may have multiple addresses with different uses or applicable periods.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An address for the individual.", "id": "Patient.address", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-11" }, { "identity": "rim", "map": "addr" }, { "identity": "cda", "map": ".addr" } ], "max": "0", "min": 0, "path": "Patient.address", "requirements": "May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.", "short": "An address for the individual", "type": [ { "code": "Address" } ] }, { "base": { "max": "1", "min": 0, "path": "Patient.maritalStatus" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/marital-status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This field contains a patient's most recent marital (civil) status.", "id": "Patient.maritalStatus", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PID-16" }, { "identity": "rim", "map": "player[classCode=PSN]/maritalStatusCode" }, { "identity": "cda", "map": ".patient.maritalStatusCode" } ], "max": "1", "min": 0, "path": "Patient.maritalStatus", "requirements": "Most, if not all systems capture it.", "short": "Marital (civil) status of a patient", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Patient.maritalStatus.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.maritalStatus.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.maritalStatus.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.maritalStatus.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Patient.maritalStatus.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Patient.maritalStatus.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Patient.maritalStatus.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.maritalStatus.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.maritalStatus.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.maritalStatus.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Patient.maritalStatus.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Patient.maritalStatus.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system\r\n[ES: Ejemplo: http://terminology.hl7.org/CodeSystem/v3-MaritalStatus]", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Patient.maritalStatus.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Patient.maritalStatus.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Patient.maritalStatus.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Patient.maritalStatus.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system[ES: Ejemplo: M]", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Patient.maritalStatus.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Patient.maritalStatus.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system [ES: Ejemplo: Married]", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Patient.maritalStatus.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Patient.maritalStatus.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Patient.maritalStatus.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Patient.maritalStatus.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Patient.multipleBirth[x]" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).", "id": "Patient.multipleBirth[x]", "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" } ], "max": "1", "min": 0, "path": "Patient.multipleBirth[x]", "requirements": "For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.", "short": "Whether patient is part of a multiple birth", "type": [ { "code": "boolean" }, { "code": "integer" } ] }, { "base": { "max": "*", "min": 0, "path": "Patient.photo" }, "comment": "Guidelines:\n* Use id photos, not clinical photos.\n* Limit dimensions to thumbnail.\n* Keep byte count low to ease resource updates.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Image of the patient.", "id": "Patient.photo", "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" } ], "max": "0", "min": 0, "path": "Patient.photo", "requirements": "Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.", "short": "Image of the patient", "type": [ { "code": "Attachment" } ] }, { "base": { "max": "*", "min": 0, "path": "Patient.contact" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "name.exists() or telecom.exists() or address.exists() or organization.exists()", "human": "SHALL at least contain a contact's details or a reference to an organization", "key": "pat-1", "severity": "error", "xpath": "exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)" } ], "definition": "A contact party (e.g. guardian, partner, friend) for the patient.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Contact" } ], "id": "Patient.contact", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]" }, { "identity": "cda", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.contact", "requirements": "Need to track people you can contact about the patient.", "short": "A contact party (e.g. guardian, partner, friend) for the patient", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Patient.contact.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.contact.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.contact.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.contact.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Patient.contact.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Patient.contact.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Patient.contact.relationship" }, "binding": { "description": "The nature of the relationship between a patient and a contact person for that patient.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactRelationship" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/patient-contactrelationship" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The nature of the relationship between the patient and the contact person.", "id": "Patient.contact.relationship", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "NK1-7, NK1-3" }, { "identity": "rim", "map": "code" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 1, "path": "Patient.contact.relationship", "requirements": "Used to determine which contact person is the most relevant to approach, depending on circumstances.", "short": "The kind of relationship", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Patient.contact.relationship.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.contact.relationship.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.contact.relationship.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.contact.relationship.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Patient.contact.relationship.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Patient.contact.relationship.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Patient.contact.relationship.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.contact.relationship.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.contact.relationship.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.contact.relationship.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Patient.contact.relationship.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Patient.contact.relationship.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Patient.contact.relationship.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Patient.contact.relationship.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Patient.contact.relationship.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Patient.contact.relationship.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Patient.contact.relationship.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Patient.contact.relationship.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Patient.contact.relationship.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Patient.contact.relationship.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Patient.contact.relationship.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Patient.contact.relationship.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Patient.contact.name" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A name associated with the contact person.", "id": "Patient.contact.name", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "NK1-2" }, { "identity": "rim", "map": "name" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 1, "path": "Patient.contact.name", "requirements": "Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.", "short": "A name associated with the contact person", "type": [ { "code": "HumanName" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Patient.contact.name.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.contact.name.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.contact.name.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.contact.name.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "HumanName.use" }, "binding": { "description": "The use of a human name.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "NameUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/name-use|4.0.1" }, "comment": "Applications can assume that a name is current unless it explicitly says that it is temporary or old.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the purpose for this name.", "id": "Patient.contact.name.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.7, but often indicated by which field contains the name" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./NamePurpose" } ], "max": "1", "min": 1, "path": "Patient.contact.name.use", "requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.", "short": "usual | official | temp | nickname | anonymous | old | maiden", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "HumanName.text" }, "comment": "Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.", "id": "Patient.contact.name.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "implied by XPN.11" }, { "identity": "rim", "map": "./formatted" } ], "max": "1", "min": 1, "path": "Patient.contact.name.text", "requirements": "A renderable, unencoded form.", "short": "Text representation of the full name", "type": [ { "code": "string" } ] }, { "alias": [ "surname" ], "base": { "max": "1", "min": 0, "path": "HumanName.family" }, "comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.", "id": "Patient.contact.name.family", "isModifier": false, "isSummary": true, "label": "Apellidos", "mapping": [ { "identity": "v2", "map": "XPN.1/FN.1" }, { "identity": "rim", "map": "./part[partType = FAM]" }, { "identity": "servd", "map": "./FamilyName" } ], "max": "1", "min": 1, "path": "Patient.contact.name.family", "short": "Patient's family name", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "unique id for the element within a resource (for internal references)", "id": "Patient.contact.name.family.id", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Patient.contact.name.family.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "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.", "id": "Patient.contact.name.family.extension", "isModifier": false, "isSummary": false, "max": "*", "min": 0, "path": "Patient.contact.name.family.extension", "short": "Additional content defined by implementations", "slicing": { "discriminator": [ { "path": "url", "type": "value" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "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.", "id": "Patient.contact.name.family.extension:FathersFamilyName", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Patient.contact.name.family.extension", "short": "Additional content defined by implementations", "sliceName": "FathersFamilyName", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-FathersFamilyName" ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "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.", "id": "Patient.contact.name.family.extension:MothersFamilyName", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Patient.contact.name.family.extension", "short": "Additional content defined by implementations", "sliceName": "MothersFamilyName", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-MothersFamilyName" ] } ] }, { "base": { "max": "1", "min": 0, "path": "string.value" }, "definition": "The actual value", "id": "Patient.contact.name.family.value", "isModifier": false, "isSummary": false, "max": "1", "maxLength": 1048576, "min": 0, "path": "Patient.contact.name.family.value", "representation": [ "xmlAttr" ], "short": "Primitive value for string", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" }, { "url": "http://hl7.org/fhir/StructureDefinition/regex", "valueString": "[ \\r\\n\\t\\S]+" } ] } ] }, { "alias": [ "first name", "middle name" ], "base": { "max": "*", "min": 0, "path": "HumanName.given" }, "comment": "If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called \"first name\" since given names do not always come first.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Given name.", "id": "Patient.contact.name.given", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.2 + XPN.3" }, { "identity": "rim", "map": "./part[partType = GIV]" }, { "identity": "servd", "map": "./GivenNames" } ], "max": "1", "min": 1, "orderMeaning": "Given Names appear in the correct order for presenting the name", "path": "Patient.contact.name.given", "short": "Given names (not always 'first'). Includes middle names", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "HumanName.prefix" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.", "id": "Patient.contact.name.prefix", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.5" }, { "identity": "rim", "map": "./part[partType = PFX]" }, { "identity": "servd", "map": "./TitleCode" } ], "max": "0", "min": 0, "orderMeaning": "Prefixes appear in the correct order for presenting the name", "path": "Patient.contact.name.prefix", "short": "Parts that come before the name", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "HumanName.suffix" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.", "id": "Patient.contact.name.suffix", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN/4" }, { "identity": "rim", "map": "./part[partType = SFX]" } ], "max": "0", "min": 0, "orderMeaning": "Suffixes appear in the correct order for presenting the name", "path": "Patient.contact.name.suffix", "short": "Parts that come after the name", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "HumanName.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the period of time when this name was valid for the named person.", "id": "Patient.contact.name.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.13 + XPN.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Patient.contact.name.period", "requirements": "Allows names to be placed in historical context.", "short": "Time period when name was/is in use", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "Patient.contact.telecom" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A contact detail for the person, e.g. a telephone number or an email address.", "id": "Patient.contact.telecom", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "NK1-5, NK1-6, NK1-40" }, { "identity": "rim", "map": "telecom" }, { "identity": "cda", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.contact.telecom", "requirements": "People have (primary) ways to contact them in some way such as phone, email.", "short": "A contact detail for the person", "type": [ { "code": "ContactPoint" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Patient.contact.telecom.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.contact.telecom.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.contact.telecom.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.contact.telecom.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.system" }, "binding": { "description": "Telecommunications form for contact point.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPointSystem" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1" }, "condition": [ "cpt-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.", "id": "Patient.contact.telecom.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.3" }, { "identity": "rim", "map": "./scheme" }, { "identity": "servd", "map": "./ContactPointType" } ], "max": "1", "min": 1, "path": "Patient.contact.telecom.system", "short": "phone | fax | email | pager | url | sms | other", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.value" }, "comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).", "id": "Patient.contact.telecom.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.1 (or XTN.12)" }, { "identity": "rim", "map": "./url" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Patient.contact.telecom.value", "requirements": "Need to support legacy numbers that are not in a tightly controlled format.", "short": "The actual contact point details", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.use" }, "binding": { "description": "Use of contact point.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPointUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1" }, "comment": "Applications can assume that a contact is current unless it explicitly says that it is temporary or old.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the purpose for the contact point.", "id": "Patient.contact.telecom.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.2 - but often indicated by field" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./ContactPointPurpose" } ], "max": "1", "min": 0, "path": "Patient.contact.telecom.use", "requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.", "short": "home | work | temp | old | mobile - purpose of this contact point", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.rank" }, "comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.", "id": "Patient.contact.telecom.rank", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.contact.telecom.rank", "short": "Specify preferred order of use (1 = highest)", "type": [ { "code": "positiveInt" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period when the contact point was/is in use.", "id": "Patient.contact.telecom.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "1", "min": 0, "path": "Patient.contact.telecom.period", "short": "Time period when the contact point was/is in use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Patient.contact.address" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Address for the contact person.", "id": "Patient.contact.address", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "NK1-4" }, { "identity": "rim", "map": "addr" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.contact.address", "requirements": "Need to keep track where the contact person can be contacted per postal mail or visited.", "short": "Address for the contact person", "type": [ { "code": "Address" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Patient.contact.address.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.contact.address.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.contact.address.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.contact.address.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.use" }, "binding": { "description": "The use of an address.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/address-use|4.0.1" }, "comment": "Applications can assume that an address is current unless it explicitly says that it is temporary or old.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this address.", "example": [ { "label": "General", "valueCode": "home" } ], "id": "Patient.contact.address.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.7" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./AddressPurpose" } ], "max": "1", "min": 0, "path": "Patient.contact.address.use", "requirements": "Allows an appropriate address to be chosen from a list of many.", "short": "home | work | temp | old | billing - purpose of this address", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.type" }, "binding": { "description": "The type of an address (physical / postal).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/address-type|4.0.1" }, "comment": "The definition of Address states that \"address is intended to describe postal addresses, not physical locations\". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](location.html#) resource).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.", "example": [ { "label": "General", "valueCode": "both" } ], "id": "Patient.contact.address.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.18" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "vcard", "map": "address type parameter" } ], "max": "1", "min": 1, "path": "Patient.contact.address.type", "short": "postal | physical | both", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.text" }, "comment": "Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.", "example": [ { "label": "General", "valueString": "137 Nowhere Street, Erewhon 9132" } ], "id": "Patient.contact.address.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6" }, { "identity": "rim", "map": "./formatted" }, { "identity": "vcard", "map": "address label parameter" } ], "max": "1", "min": 0, "path": "Patient.contact.address.text", "requirements": "A renderable, unencoded form.", "short": "Text representation of the address", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Address.line" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.", "example": [ { "label": "General", "valueString": "137 Nowhere Street" } ], "id": "Patient.contact.address.line", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "vcard", "map": "street" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ], "max": "*", "min": 0, "orderMeaning": "The order in which lines should appear in an address label", "path": "Patient.contact.address.line", "short": "Street name, number, direction & P.O. Box etc.", "type": [ { "code": "string" } ] }, { "alias": [ "Municpality" ], "base": { "max": "1", "min": 0, "path": "Address.city" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The name of the city, town, suburb, village or other community or delivery center.", "example": [ { "label": "General", "valueString": "Erewhon" } ], "id": "Patient.contact.address.city", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.3" }, { "identity": "rim", "map": "AD.part[parttype = CTY]" }, { "identity": "vcard", "map": "locality" }, { "identity": "servd", "map": "./Jurisdiction" } ], "max": "1", "min": 0, "path": "Patient.contact.address.city", "short": "Name of city, town etc.", "type": [ { "code": "string" } ] }, { "alias": [ "County" ], "base": { "max": "1", "min": 0, "path": "Address.district" }, "comment": "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The name of the administrative area (county).", "example": [ { "label": "General", "valueString": "Madison" } ], "id": "Patient.contact.address.district", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.9" }, { "identity": "rim", "map": "AD.part[parttype = CNT | CPA]" } ], "max": "1", "min": 0, "path": "Patient.contact.address.district", "short": "District name (aka county)", "type": [ { "code": "string" } ] }, { "alias": [ "Province", "Territory" ], "base": { "max": "1", "min": 0, "path": "Address.state" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).", "id": "Patient.contact.address.state", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.4" }, { "identity": "rim", "map": "AD.part[parttype = STA]" }, { "identity": "vcard", "map": "region" }, { "identity": "servd", "map": "./Region" } ], "max": "1", "min": 0, "path": "Patient.contact.address.state", "short": "Sub-unit of country (abbreviations ok)", "type": [ { "code": "string" } ] }, { "alias": [ "Zip" ], "base": { "max": "1", "min": 0, "path": "Address.postalCode" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A postal code designating a region defined by the postal service.", "example": [ { "label": "General", "valueString": "9132" } ], "id": "Patient.contact.address.postalCode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.5" }, { "identity": "rim", "map": "AD.part[parttype = ZIP]" }, { "identity": "vcard", "map": "code" }, { "identity": "servd", "map": "./PostalIdentificationCode" } ], "max": "1", "min": 0, "path": "Patient.contact.address.postalCode", "short": "Postal code for area", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.country" }, "comment": "ISO 3166 3 letter codes can be used in place of a human readable country name.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Country - a nation as commonly understood or generally accepted.", "id": "Patient.contact.address.country", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.6" }, { "identity": "rim", "map": "AD.part[parttype = CNT]" }, { "identity": "vcard", "map": "country" }, { "identity": "servd", "map": "./Country" } ], "max": "1", "min": 0, "path": "Patient.contact.address.country", "short": "Country (e.g. can be ISO 3166 2 or 3 letter code)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period when address was/is in use.", "example": [ { "label": "General", "valuePeriod": { "end": "2010-07-01", "start": "2010-03-23" } } ], "id": "Patient.contact.address.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.12 / XAD.13 + XAD.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "1", "min": 0, "path": "Patient.contact.address.period", "requirements": "Allows addresses to be placed in historical context.", "short": "Time period when address was/is in use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Patient.contact.gender" }, "binding": { "description": "The gender of a person used for administrative purposes.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdministrativeGender" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.", "id": "Patient.contact.gender", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "NK1-15" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.contact.gender", "requirements": "Needed to address the person correctly.", "short": "male | female | other | unknown", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Patient.contact.organization" }, "condition": [ "pat-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization on behalf of which the contact is acting or for which the contact is working.", "id": "Patient.contact.organization", "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" } ], "max": "1", "min": 0, "path": "Patient.contact.organization", "requirements": "For guardians or business related contacts, the organization is relevant.", "short": "Organization that is associated with the contact", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Patient.contact.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The period during which this contact person or organization is valid to be contacted relating to this patient.", "id": "Patient.contact.period", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "effectiveTime" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.contact.period", "short": "The period during which this contact person or organization is valid to be contacted relating to this patient", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "Patient.communication" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A language which may be used to communicate with the patient about his or her health.", "id": "Patient.communication", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "LanguageCommunication" }, { "identity": "cda", "map": "patient.languageCommunication" } ], "max": "0", "min": 0, "path": "Patient.communication", "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.", "short": "A language which may be used to communicate with the patient about his or her health", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Patient.communication.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.communication.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.communication.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.communication.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Patient.communication.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Patient.communication.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Patient.communication.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Patient.communication.language", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PID-15, LAN-2" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code" }, { "identity": "cda", "map": ".languageCode" } ], "max": "1", "min": 1, "path": "Patient.communication.language", "requirements": "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.", "short": "The language which can be used to communicate with the patient about his or her health", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Patient.communication.preferred" }, "comment": "This language is specifically identified for communicating healthcare information.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).", "id": "Patient.communication.preferred", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PID-15" }, { "identity": "rim", "map": "preferenceInd" }, { "identity": "cda", "map": ".preferenceInd" } ], "max": "1", "min": 0, "path": "Patient.communication.preferred", "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.", "short": "Language preference indicator", "type": [ { "code": "boolean" } ] }, { "alias": [ "careProvider" ], "base": { "max": "*", "min": 0, "path": "Patient.generalPractitioner" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Patient's nominated care provider.", "id": "Patient.generalPractitioner", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PD1-4" }, { "identity": "rim", "map": "subjectOf.CareEvent.performer.AssignedEntity" }, { "identity": "cda", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.generalPractitioner", "short": "Patient's nominated primary care provider", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Patient.managingOrganization" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that is the custodian of the patient record.", "id": "Patient.managingOrganization", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "scoper" }, { "identity": "cda", "map": ".providerOrganization" } ], "max": "1", "min": 0, "path": "Patient.managingOrganization", "requirements": "Need to know who recognizes this patient record, manages and updates it.", "short": "Organization that is the custodian of the patient record", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Patient.link" }, "comment": "There is no assumption that linked patient records have mutual links.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Link to another patient resource that concerns the same actual patient.", "id": "Patient.link", "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" } ], "max": "0", "min": 0, "path": "Patient.link", "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.", "short": "Link to another patient resource that concerns the same actual person", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Patient.link.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Patient.link.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Patient.link.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Patient.link.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Patient.link.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Patient.link.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Patient.link.other" }, "comment": "Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The other patient resource that the link refers to.", "id": "Patient.link.other", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3, MRG-1" }, { "identity": "rim", "map": "id" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 1, "path": "Patient.link.other", "short": "The other patient or related person resource that the link refers to", "type": [ { "code": "Reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", "valueBoolean": false } ], "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Patient.link.type" }, "binding": { "description": "The type of link between this patient resource and another patient resource.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "LinkType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/link-type|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The type of link between this patient resource and another patient resource.", "id": "Patient.link.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "typeCode" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 1, "path": "Patient.link.type", "short": "replaced-by | replaces | refer | seealso", "type": [ { "code": "code" } ] } ] }, "status": "draft", "title": "OneHealth Patient", "type": "Patient", "url": "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/OrganizationOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Organization", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2023-12-05", "derivation": "constraint", "description": "FHIR OrganizationOH, for OH interoperability scenarios, based on the national CORE Organization Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Organization.extension", "path": "Organization.extension", "slicing": { "discriminator": [ { "path": "url", "type": "value" } ], "rules": "closed" } }, { "definition": "Extension used in the Person.address.city element to register the code of the province", "id": "Organization.extension:Extension-Province", "max": "1", "min": 0, "path": "Organization.extension", "short": "Province code", "sliceName": "Extension-Province", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-province" ] } ] }, { "definition": "Extension used in the Person.address.district element to register the code of the district", "id": "Organization.extension:Extension-District", "max": "1", "min": 0, "path": "Organization.extension", "short": "District code", "sliceName": "Extension-District", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-district" ] } ] }, { "definition": "Extension used in the Person.address.state element to register the code of the department", "id": "Organization.extension:Extension-Department", "max": "1", "min": 0, "path": "Organization.extension", "short": "Department code", "sliceName": "Extension-Department", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-department" ] } ] }, { "id": "Organization.identifier", "max": "1", "min": 1, "path": "Organization.identifier" }, { "id": "Organization.identifier.use", "min": 1, "path": "Organization.identifier.use" }, { "id": "Organization.identifier.type", "min": 1, "path": "Organization.identifier.type" }, { "id": "Organization.identifier.type.coding", "max": "1", "min": 1, "path": "Organization.identifier.type.coding" }, { "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/CodeSystem/v2-0203" }, "id": "Organization.identifier.type.coding.system", "min": 1, "path": "Organization.identifier.type.coding.system" }, { "id": "Organization.identifier.type.coding.version", "max": "0", "path": "Organization.identifier.type.coding.version" }, { "fixedCode": "TAX", "id": "Organization.identifier.type.coding.code", "min": 1, "path": "Organization.identifier.type.coding.code" }, { "fixedString": "Tax ID number", "id": "Organization.identifier.type.coding.display", "min": 1, "path": "Organization.identifier.type.coding.display" }, { "id": "Organization.identifier.type.coding.userSelected", "max": "0", "path": "Organization.identifier.type.coding.userSelected" }, { "id": "Organization.identifier.type.text", "max": "0", "path": "Organization.identifier.type.text" }, { "id": "Organization.identifier.system", "min": 1, "path": "Organization.identifier.system" }, { "id": "Organization.identifier.value", "min": 1, "path": "Organization.identifier.value" }, { "id": "Organization.identifier.period", "max": "0", "path": "Organization.identifier.period" }, { "id": "Organization.identifier.assigner", "path": "Organization.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Organization.active", "min": 1, "path": "Organization.active" }, { "id": "Organization.type", "min": 1, "path": "Organization.type" }, { "id": "Organization.type.coding", "min": 1, "path": "Organization.type.coding" }, { "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/CodeSystem/organization-type" }, "id": "Organization.type.coding.system", "min": 1, "path": "Organization.type.coding.system" }, { "id": "Organization.type.coding.version", "max": "0", "path": "Organization.type.coding.version" }, { "id": "Organization.type.coding.code", "min": 1, "path": "Organization.type.coding.code" }, { "id": "Organization.type.coding.display", "min": 1, "path": "Organization.type.coding.display" }, { "id": "Organization.type.coding.userSelected", "max": "0", "path": "Organization.type.coding.userSelected" }, { "id": "Organization.type.text", "max": "0", "path": "Organization.type.text" }, { "id": "Organization.name", "min": 1, "path": "Organization.name" }, { "id": "Organization.telecom.system", "min": 1, "path": "Organization.telecom.system" }, { "id": "Organization.telecom.value", "min": 1, "path": "Organization.telecom.value" }, { "definition": "An address for the individual. [ES: Una dirección de la persona]", "id": "Organization.address", "label": "Dirección", "mustSupport": true, "path": "Organization.address", "short": "An address for the individual" }, { "id": "Organization.address.use", "min": 1, "path": "Organization.address.use", "patternCode": "work" }, { "id": "Organization.address.type", "min": 1, "path": "Organization.address.type", "patternCode": "physical" }, { "id": "Organization.address.text", "min": 1, "path": "Organization.address.text" }, { "id": "Organization.address.city", "label": "País", "max": "0", "path": "Organization.address.city" }, { "id": "Organization.address.district", "max": "0", "path": "Organization.address.district" }, { "id": "Organization.address.state", "max": "0", "path": "Organization.address.state" }, { "id": "Organization.address.country", "min": 1, "mustSupport": true, "path": "Organization.address.country", "short": "Country" }, { "id": "Organization.address.period", "max": "0", "path": "Organization.address.period" }, { "id": "Organization.contact.purpose", "min": 1, "path": "Organization.contact.purpose" }, { "id": "Organization.contact.purpose.coding", "min": 1, "path": "Organization.contact.purpose.coding" }, { "id": "Organization.contact.purpose.coding.system", "min": 1, "path": "Organization.contact.purpose.coding.system" }, { "id": "Organization.contact.purpose.coding.version", "max": "0", "path": "Organization.contact.purpose.coding.version" }, { "id": "Organization.contact.purpose.coding.code", "min": 1, "path": "Organization.contact.purpose.coding.code" }, { "id": "Organization.contact.purpose.coding.display", "min": 1, "path": "Organization.contact.purpose.coding.display" }, { "id": "Organization.contact.purpose.coding.userSelected", "max": "0", "path": "Organization.contact.purpose.coding.userSelected" }, { "id": "Organization.contact.purpose.text", "max": "0", "path": "Organization.contact.purpose.text" }, { "id": "Organization.contact.name", "min": 1, "path": "Organization.contact.name" }, { "id": "Organization.contact.name.use", "min": 1, "path": "Organization.contact.name.use" }, { "id": "Organization.contact.name.text", "min": 1, "path": "Organization.contact.name.text" }, { "id": "Organization.contact.name.family", "label": "Apellidos", "min": 1, "path": "Organization.contact.name.family", "short": "Organization family name" }, { "id": "Organization.contact.name.family.extension", "path": "Organization.contact.name.family.extension", "slicing": { "discriminator": [ { "path": "url", "type": "value" } ], "ordered": false, "rules": "open" } }, { "id": "Organization.contact.name.family.extension:FathersFamilyName", "max": "1", "min": 0, "path": "Organization.contact.name.family.extension", "sliceName": "FathersFamilyName", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-FathersFamilyName" ] } ] }, { "id": "Organization.contact.name.family.extension:MothersFamilyName", "max": "1", "min": 0, "path": "Organization.contact.name.family.extension", "sliceName": "MothersFamilyName", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-MothersFamilyName" ] } ] }, { "id": "Organization.contact.name.given", "max": "1", "min": 1, "path": "Organization.contact.name.given" }, { "id": "Organization.contact.name.prefix", "max": "0", "path": "Organization.contact.name.prefix" }, { "id": "Organization.contact.name.suffix", "max": "0", "path": "Organization.contact.name.suffix" }, { "id": "Organization.contact.name.period", "max": "0", "path": "Organization.contact.name.period" }, { "id": "Organization.contact.telecom.system", "min": 1, "path": "Organization.contact.telecom.system" }, { "id": "Organization.contact.telecom.value", "min": 1, "path": "Organization.contact.telecom.value" }, { "id": "Organization.contact.address.type", "min": 1, "path": "Organization.contact.address.type" } ] }, "fhirVersion": "4.0.1", "id": "OrganizationOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "servd", "name": "ServD", "uri": "http://www.omg.org/spec/ServD/1.0/" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" } ], "meta": { "lastUpdated": "2024-04-12T17:46:26.107565+00:00", "versionId": "MTcxMjk0Mzk4NjEwNzU2NTAwMA" }, "name": "OrganizationOH", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Organization" }, "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "(identifier.count() + name.count()) > 0", "human": "The organization SHALL at least have a name or an identifier, and possibly more than one", "key": "org-1", "severity": "error", "xpath": "count(f:identifier | f:name) > 0" } ], "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.", "id": "Organization", "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" } ], "max": "*", "min": 0, "path": "Organization", "short": "A grouping of people or organizations with a common purpose" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Organization.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Organization.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Organization.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Organization.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Organization.implicitRules", "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, "max": "1", "min": 0, "path": "Organization.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Organization.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Organization.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Organization.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Organization.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Organization.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Organization.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Organization.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Organization.extension", "short": "Additional content defined by implementations", "slicing": { "discriminator": [ { "path": "url", "type": "value" } ], "rules": "closed" }, "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "definition": "Extension used in the Person.address.city element to register the code of the province", "id": "Organization.extension:Extension-Province", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Organization.extension", "short": "Province code", "sliceName": "Extension-Province", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-province" ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "definition": "Extension used in the Person.address.district element to register the code of the district", "id": "Organization.extension:Extension-District", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Organization.extension", "short": "District code", "sliceName": "Extension-District", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-district" ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "definition": "Extension used in the Person.address.state element to register the code of the department", "id": "Organization.extension:Extension-Department", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Organization.extension", "short": "Department code", "sliceName": "Extension-Department", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-department" ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Organization.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Organization.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Organization.identifier" }, "condition": [ "org-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.", "id": "Organization.identifier", "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" } ], "max": "1", "min": 1, "path": "Organization.identifier", "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.", "short": "Identifies this organization across multiple systems", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Organization.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Organization.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Organization.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "Organization.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "Organization.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "Organization.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "Organization.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Organization.identifier.type.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.identifier.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Organization.identifier.type.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Organization.identifier.type.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Organization.identifier.type.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Organization.identifier.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Organization.identifier.type.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.identifier.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Organization.identifier.type.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Organization.identifier.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/CodeSystem/v2-0203" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Organization.identifier.type.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Organization.identifier.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Organization.identifier.type.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Organization.identifier.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "fixedCode": "TAX", "id": "Organization.identifier.type.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Organization.identifier.type.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "fixedString": "Tax ID number", "id": "Organization.identifier.type.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Organization.identifier.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Organization.identifier.type.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Organization.identifier.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Organization.identifier.type.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Organization.identifier.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "Organization.identifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 1, "path": "Organization.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "example": [ { "label": "General", "valueString": "123456" } ], "id": "Organization.identifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Organization.identifier.value", "short": "The value that is unique", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "Organization.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Organization.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "Organization.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 0, "path": "Organization.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Organization.active" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Whether the organization's record is still in active use.", "id": "Organization.active", "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." } ], "max": "1", "meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element", "min": 1, "path": "Organization.active", "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.", "short": "Whether the organization's record is still in active use", "type": [ { "code": "boolean" } ] }, { "base": { "max": "*", "min": 0, "path": "Organization.type" }, "binding": { "description": "Used to categorize the organization.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "OrganizationType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/organization-type" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The kind(s) of organization that this is.", "id": "Organization.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "v2", "map": "No equivalent in v2" }, { "identity": "rim", "map": ".code" }, { "identity": "servd", "map": "n/a" } ], "max": "*", "min": 1, "path": "Organization.type", "requirements": "Need to be able to track the kind of organization that this is - different organization types have different uses.", "short": "Kind of organization", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Organization.type.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Organization.type.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Organization.type.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Organization.type.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 1, "path": "Organization.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Organization.type.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Organization.type.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Organization.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/CodeSystem/organization-type" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Organization.type.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Organization.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Organization.type.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Organization.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Organization.type.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Organization.type.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Organization.type.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Organization.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Organization.type.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Organization.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Organization.type.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Organization.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Organization.name" }, "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.", "condition": [ "org-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A name associated with the organization.", "id": "Organization.name", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XON.1" }, { "identity": "rim", "map": ".name" }, { "identity": "servd", "map": ".PreferredName/Name" } ], "max": "1", "min": 1, "path": "Organization.name", "requirements": "Need to use the name as the label of the organization.", "short": "Name used for the organization", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Organization.alias" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A list of alternate names that the organization is known as, or was known as in the past.", "id": "Organization.alias", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".name" } ], "max": "*", "min": 0, "path": "Organization.alias", "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.", "short": "A list of alternate names that the organization is known as, or was known as in the past", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Organization.telecom" }, "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.", "condition": [ "org-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "where(use = 'home').empty()", "human": "The telecom of an organization can never be of use 'home'", "key": "org-3", "severity": "error", "xpath": "count(f:use[@value='home']) = 0" } ], "definition": "A contact detail for the organization.", "id": "Organization.telecom", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "ORC-22?" }, { "identity": "rim", "map": ".telecom" }, { "identity": "servd", "map": "./ContactPoints" } ], "max": "*", "min": 0, "path": "Organization.telecom", "requirements": "Human contact for the organization.", "short": "A contact detail for the organization", "type": [ { "code": "ContactPoint" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Organization.telecom.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.telecom.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Organization.telecom.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Organization.telecom.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.system" }, "binding": { "description": "Telecommunications form for contact point.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPointSystem" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1" }, "condition": [ "cpt-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.", "id": "Organization.telecom.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.3" }, { "identity": "rim", "map": "./scheme" }, { "identity": "servd", "map": "./ContactPointType" } ], "max": "1", "min": 1, "path": "Organization.telecom.system", "short": "phone | fax | email | pager | url | sms | other", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.value" }, "comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).", "id": "Organization.telecom.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.1 (or XTN.12)" }, { "identity": "rim", "map": "./url" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Organization.telecom.value", "requirements": "Need to support legacy numbers that are not in a tightly controlled format.", "short": "The actual contact point details", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.use" }, "binding": { "description": "Use of contact point.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPointUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1" }, "comment": "Applications can assume that a contact is current unless it explicitly says that it is temporary or old.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the purpose for the contact point.", "id": "Organization.telecom.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.2 - but often indicated by field" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./ContactPointPurpose" } ], "max": "1", "min": 0, "path": "Organization.telecom.use", "requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.", "short": "home | work | temp | old | mobile - purpose of this contact point", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.rank" }, "comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.", "id": "Organization.telecom.rank", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.telecom.rank", "short": "Specify preferred order of use (1 = highest)", "type": [ { "code": "positiveInt" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period when the contact point was/is in use.", "id": "Organization.telecom.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "1", "min": 0, "path": "Organization.telecom.period", "short": "Time period when the contact point was/is in use", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "Organization.address" }, "comment": "Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.", "condition": [ "org-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "where(use = 'home').empty()", "human": "An address of an organization can never be of use 'home'", "key": "org-2", "severity": "error", "xpath": "count(f:use[@value='home']) = 0" } ], "definition": "An address for the individual. [ES: Una dirección de la persona]", "id": "Organization.address", "isModifier": false, "isSummary": false, "label": "Dirección", "mapping": [ { "identity": "v2", "map": "ORC-23?" }, { "identity": "rim", "map": ".address" }, { "identity": "servd", "map": "./PrimaryAddress and ./OtherAddresses" } ], "max": "*", "min": 0, "mustSupport": true, "path": "Organization.address", "requirements": "May need to keep track of the organization's addresses for contacting, billing or reporting requirements.", "short": "An address for the individual", "type": [ { "code": "Address" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Organization.address.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.address.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Organization.address.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Organization.address.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.use" }, "binding": { "description": "The use of an address.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/address-use|4.0.1" }, "comment": "Applications can assume that an address is current unless it explicitly says that it is temporary or old.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this address.", "example": [ { "label": "General", "valueCode": "home" } ], "id": "Organization.address.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.7" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./AddressPurpose" } ], "max": "1", "min": 1, "path": "Organization.address.use", "patternCode": "work", "requirements": "Allows an appropriate address to be chosen from a list of many.", "short": "home | work | temp | old | billing - purpose of this address", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.type" }, "binding": { "description": "The type of an address (physical / postal).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/address-type|4.0.1" }, "comment": "The definition of Address states that \"address is intended to describe postal addresses, not physical locations\". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](location.html#) resource).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.", "example": [ { "label": "General", "valueCode": "both" } ], "id": "Organization.address.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.18" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "vcard", "map": "address type parameter" } ], "max": "1", "min": 1, "path": "Organization.address.type", "patternCode": "physical", "short": "postal | physical | both", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.text" }, "comment": "Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.", "example": [ { "label": "General", "valueString": "137 Nowhere Street, Erewhon 9132" } ], "id": "Organization.address.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6" }, { "identity": "rim", "map": "./formatted" }, { "identity": "vcard", "map": "address label parameter" } ], "max": "1", "min": 1, "path": "Organization.address.text", "requirements": "A renderable, unencoded form.", "short": "Text representation of the address", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Address.line" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.", "example": [ { "label": "General", "valueString": "137 Nowhere Street" } ], "id": "Organization.address.line", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "vcard", "map": "street" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ], "max": "*", "min": 0, "orderMeaning": "The order in which lines should appear in an address label", "path": "Organization.address.line", "short": "Street name, number, direction & P.O. Box etc.", "type": [ { "code": "string" } ] }, { "alias": [ "Municpality" ], "base": { "max": "1", "min": 0, "path": "Address.city" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The name of the city, town, suburb, village or other community or delivery center.", "example": [ { "label": "General", "valueString": "Erewhon" } ], "id": "Organization.address.city", "isModifier": false, "isSummary": true, "label": "País", "mapping": [ { "identity": "v2", "map": "XAD.3" }, { "identity": "rim", "map": "AD.part[parttype = CTY]" }, { "identity": "vcard", "map": "locality" }, { "identity": "servd", "map": "./Jurisdiction" } ], "max": "0", "min": 0, "path": "Organization.address.city", "short": "Name of city, town etc.", "type": [ { "code": "string" } ] }, { "alias": [ "County" ], "base": { "max": "1", "min": 0, "path": "Address.district" }, "comment": "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The name of the administrative area (county).", "example": [ { "label": "General", "valueString": "Madison" } ], "id": "Organization.address.district", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.9" }, { "identity": "rim", "map": "AD.part[parttype = CNT | CPA]" } ], "max": "0", "min": 0, "path": "Organization.address.district", "short": "District name (aka county)", "type": [ { "code": "string" } ] }, { "alias": [ "Province", "Territory" ], "base": { "max": "1", "min": 0, "path": "Address.state" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).", "id": "Organization.address.state", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.4" }, { "identity": "rim", "map": "AD.part[parttype = STA]" }, { "identity": "vcard", "map": "region" }, { "identity": "servd", "map": "./Region" } ], "max": "0", "min": 0, "path": "Organization.address.state", "short": "Sub-unit of country (abbreviations ok)", "type": [ { "code": "string" } ] }, { "alias": [ "Zip" ], "base": { "max": "1", "min": 0, "path": "Address.postalCode" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A postal code designating a region defined by the postal service.", "example": [ { "label": "General", "valueString": "9132" } ], "id": "Organization.address.postalCode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.5" }, { "identity": "rim", "map": "AD.part[parttype = ZIP]" }, { "identity": "vcard", "map": "code" }, { "identity": "servd", "map": "./PostalIdentificationCode" } ], "max": "1", "min": 0, "path": "Organization.address.postalCode", "short": "Postal code for area", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.country" }, "comment": "ISO 3166 3 letter codes can be used in place of a human readable country name.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Country - a nation as commonly understood or generally accepted.", "id": "Organization.address.country", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.6" }, { "identity": "rim", "map": "AD.part[parttype = CNT]" }, { "identity": "vcard", "map": "country" }, { "identity": "servd", "map": "./Country" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Organization.address.country", "short": "Country", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period when address was/is in use.", "example": [ { "label": "General", "valuePeriod": { "end": "2010-07-01", "start": "2010-03-23" } } ], "id": "Organization.address.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.12 / XAD.13 + XAD.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Organization.address.period", "requirements": "Allows addresses to be placed in historical context.", "short": "Time period when address was/is in use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Organization.partOf" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The organization of which this organization forms a part.", "id": "Organization.partOf", "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" } ], "max": "1", "min": 0, "path": "Organization.partOf", "requirements": "Need to be able to track the hierarchy of organizations within an organization.", "short": "The organization of which this organization forms a part", "type": [ { "code": "Reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", "valueBoolean": true } ], "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Organization.contact" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Contact for the organization for a certain purpose.", "id": "Organization.contact", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".contactParty" } ], "max": "*", "min": 0, "path": "Organization.contact", "requirements": "Need to keep track of assigned contact points within bigger organization.", "short": "Contact for the organization for a certain purpose", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Organization.contact.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.contact.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Organization.contact.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Organization.contact.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Organization.contact.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Organization.contact.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Organization.contact.purpose" }, "binding": { "description": "The purpose for which you would contact a contact party.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPartyType" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/contactentity-type" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates a purpose for which the contact can be reached.", "id": "Organization.contact.purpose", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./type" } ], "max": "1", "min": 1, "path": "Organization.contact.purpose", "requirements": "Need to distinguish between multiple contact persons.", "short": "The type of contact", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Organization.contact.purpose.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.contact.purpose.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Organization.contact.purpose.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Organization.contact.purpose.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Organization.contact.purpose.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 1, "path": "Organization.contact.purpose.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Organization.contact.purpose.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.contact.purpose.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Organization.contact.purpose.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Organization.contact.purpose.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Organization.contact.purpose.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Organization.contact.purpose.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Organization.contact.purpose.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Organization.contact.purpose.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Organization.contact.purpose.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Organization.contact.purpose.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Organization.contact.purpose.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Organization.contact.purpose.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Organization.contact.purpose.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Organization.contact.purpose.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Organization.contact.purpose.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Organization.contact.purpose.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Organization.contact.name" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A name associated with the contact.", "id": "Organization.contact.name", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PID-5, PID-9" }, { "identity": "rim", "map": "./name" } ], "max": "1", "min": 1, "path": "Organization.contact.name", "requirements": "Need to be able to track the person by name.", "short": "A name associated with the contact", "type": [ { "code": "HumanName" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Organization.contact.name.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.contact.name.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Organization.contact.name.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Organization.contact.name.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "HumanName.use" }, "binding": { "description": "The use of a human name.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "NameUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/name-use|4.0.1" }, "comment": "Applications can assume that a name is current unless it explicitly says that it is temporary or old.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the purpose for this name.", "id": "Organization.contact.name.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.7, but often indicated by which field contains the name" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./NamePurpose" } ], "max": "1", "min": 1, "path": "Organization.contact.name.use", "requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.", "short": "usual | official | temp | nickname | anonymous | old | maiden", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "HumanName.text" }, "comment": "Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.", "id": "Organization.contact.name.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "implied by XPN.11" }, { "identity": "rim", "map": "./formatted" } ], "max": "1", "min": 1, "path": "Organization.contact.name.text", "requirements": "A renderable, unencoded form.", "short": "Text representation of the full name", "type": [ { "code": "string" } ] }, { "alias": [ "surname" ], "base": { "max": "1", "min": 0, "path": "HumanName.family" }, "comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.", "id": "Organization.contact.name.family", "isModifier": false, "isSummary": true, "label": "Apellidos", "mapping": [ { "identity": "v2", "map": "XPN.1/FN.1" }, { "identity": "rim", "map": "./part[partType = FAM]" }, { "identity": "servd", "map": "./FamilyName" } ], "max": "1", "min": 1, "path": "Organization.contact.name.family", "short": "Organization family name", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "unique id for the element within a resource (for internal references)", "id": "Organization.contact.name.family.id", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Organization.contact.name.family.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "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.", "id": "Organization.contact.name.family.extension", "isModifier": false, "isSummary": false, "max": "*", "min": 0, "path": "Organization.contact.name.family.extension", "short": "Additional content defined by implementations", "slicing": { "discriminator": [ { "path": "url", "type": "value" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "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.", "id": "Organization.contact.name.family.extension:FathersFamilyName", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Organization.contact.name.family.extension", "short": "Additional content defined by implementations", "sliceName": "FathersFamilyName", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-FathersFamilyName" ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "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.", "id": "Organization.contact.name.family.extension:MothersFamilyName", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Organization.contact.name.family.extension", "short": "Additional content defined by implementations", "sliceName": "MothersFamilyName", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-MothersFamilyName" ] } ] }, { "base": { "max": "1", "min": 0, "path": "string.value" }, "definition": "The actual value", "id": "Organization.contact.name.family.value", "isModifier": false, "isSummary": false, "max": "1", "maxLength": 1048576, "min": 0, "path": "Organization.contact.name.family.value", "representation": [ "xmlAttr" ], "short": "Primitive value for string", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" }, { "url": "http://hl7.org/fhir/StructureDefinition/regex", "valueString": "[ \\r\\n\\t\\S]+" } ] } ] }, { "alias": [ "first name", "middle name" ], "base": { "max": "*", "min": 0, "path": "HumanName.given" }, "comment": "If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called \"first name\" since given names do not always come first.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Given name.", "id": "Organization.contact.name.given", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.2 + XPN.3" }, { "identity": "rim", "map": "./part[partType = GIV]" }, { "identity": "servd", "map": "./GivenNames" } ], "max": "1", "min": 1, "orderMeaning": "Given Names appear in the correct order for presenting the name", "path": "Organization.contact.name.given", "short": "Given names (not always 'first'). Includes middle names", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "HumanName.prefix" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.", "id": "Organization.contact.name.prefix", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.5" }, { "identity": "rim", "map": "./part[partType = PFX]" }, { "identity": "servd", "map": "./TitleCode" } ], "max": "0", "min": 0, "orderMeaning": "Prefixes appear in the correct order for presenting the name", "path": "Organization.contact.name.prefix", "short": "Parts that come before the name", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "HumanName.suffix" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.", "id": "Organization.contact.name.suffix", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN/4" }, { "identity": "rim", "map": "./part[partType = SFX]" } ], "max": "0", "min": 0, "orderMeaning": "Suffixes appear in the correct order for presenting the name", "path": "Organization.contact.name.suffix", "short": "Parts that come after the name", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "HumanName.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the period of time when this name was valid for the named person.", "id": "Organization.contact.name.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.13 + XPN.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Organization.contact.name.period", "requirements": "Allows names to be placed in historical context.", "short": "Time period when name was/is in use", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "Organization.contact.telecom" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.", "id": "Organization.contact.telecom", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PID-13, PID-14" }, { "identity": "rim", "map": "./telecom" } ], "max": "*", "min": 0, "path": "Organization.contact.telecom", "requirements": "People have (primary) ways to contact them in some way such as phone, email.", "short": "Contact details (telephone, email, etc.) for a contact", "type": [ { "code": "ContactPoint" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Organization.contact.telecom.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.contact.telecom.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Organization.contact.telecom.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Organization.contact.telecom.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.system" }, "binding": { "description": "Telecommunications form for contact point.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPointSystem" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1" }, "condition": [ "cpt-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.", "id": "Organization.contact.telecom.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.3" }, { "identity": "rim", "map": "./scheme" }, { "identity": "servd", "map": "./ContactPointType" } ], "max": "1", "min": 1, "path": "Organization.contact.telecom.system", "short": "phone | fax | email | pager | url | sms | other", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.value" }, "comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).", "id": "Organization.contact.telecom.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.1 (or XTN.12)" }, { "identity": "rim", "map": "./url" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Organization.contact.telecom.value", "requirements": "Need to support legacy numbers that are not in a tightly controlled format.", "short": "The actual contact point details", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.use" }, "binding": { "description": "Use of contact point.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ContactPointUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1" }, "comment": "Applications can assume that a contact is current unless it explicitly says that it is temporary or old.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the purpose for the contact point.", "id": "Organization.contact.telecom.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.2 - but often indicated by field" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./ContactPointPurpose" } ], "max": "1", "min": 0, "path": "Organization.contact.telecom.use", "requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.", "short": "home | work | temp | old | mobile - purpose of this contact point", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.rank" }, "comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.", "id": "Organization.contact.telecom.rank", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.contact.telecom.rank", "short": "Specify preferred order of use (1 = highest)", "type": [ { "code": "positiveInt" } ] }, { "base": { "max": "1", "min": 0, "path": "ContactPoint.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period when the contact point was/is in use.", "id": "Organization.contact.telecom.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "1", "min": 0, "path": "Organization.contact.telecom.period", "short": "Time period when the contact point was/is in use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Organization.contact.address" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Visiting or postal addresses for the contact.", "id": "Organization.contact.address", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PID-11" }, { "identity": "rim", "map": "./addr" } ], "max": "1", "min": 0, "path": "Organization.contact.address", "requirements": "May need to keep track of a contact party's address for contacting, billing or reporting requirements.", "short": "Visiting or postal addresses for the contact", "type": [ { "code": "Address" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Organization.contact.address.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Organization.contact.address.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Organization.contact.address.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Organization.contact.address.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.use" }, "binding": { "description": "The use of an address.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/address-use|4.0.1" }, "comment": "Applications can assume that an address is current unless it explicitly says that it is temporary or old.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this address.", "example": [ { "label": "General", "valueCode": "home" } ], "id": "Organization.contact.address.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.7" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./AddressPurpose" } ], "max": "1", "min": 0, "path": "Organization.contact.address.use", "requirements": "Allows an appropriate address to be chosen from a list of many.", "short": "home | work | temp | old | billing - purpose of this address", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.type" }, "binding": { "description": "The type of an address (physical / postal).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AddressType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/address-type|4.0.1" }, "comment": "The definition of Address states that \"address is intended to describe postal addresses, not physical locations\". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](location.html#) resource).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.", "example": [ { "label": "General", "valueCode": "both" } ], "id": "Organization.contact.address.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.18" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "vcard", "map": "address type parameter" } ], "max": "1", "min": 1, "path": "Organization.contact.address.type", "short": "postal | physical | both", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.text" }, "comment": "Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.", "example": [ { "label": "General", "valueString": "137 Nowhere Street, Erewhon 9132" } ], "id": "Organization.contact.address.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6" }, { "identity": "rim", "map": "./formatted" }, { "identity": "vcard", "map": "address label parameter" } ], "max": "1", "min": 0, "path": "Organization.contact.address.text", "requirements": "A renderable, unencoded form.", "short": "Text representation of the address", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Address.line" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.", "example": [ { "label": "General", "valueString": "137 Nowhere Street" } ], "id": "Organization.contact.address.line", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "vcard", "map": "street" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ], "max": "*", "min": 0, "orderMeaning": "The order in which lines should appear in an address label", "path": "Organization.contact.address.line", "short": "Street name, number, direction & P.O. Box etc.", "type": [ { "code": "string" } ] }, { "alias": [ "Municpality" ], "base": { "max": "1", "min": 0, "path": "Address.city" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The name of the city, town, suburb, village or other community or delivery center.", "example": [ { "label": "General", "valueString": "Erewhon" } ], "id": "Organization.contact.address.city", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.3" }, { "identity": "rim", "map": "AD.part[parttype = CTY]" }, { "identity": "vcard", "map": "locality" }, { "identity": "servd", "map": "./Jurisdiction" } ], "max": "1", "min": 0, "path": "Organization.contact.address.city", "short": "Name of city, town etc.", "type": [ { "code": "string" } ] }, { "alias": [ "County" ], "base": { "max": "1", "min": 0, "path": "Address.district" }, "comment": "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The name of the administrative area (county).", "example": [ { "label": "General", "valueString": "Madison" } ], "id": "Organization.contact.address.district", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.9" }, { "identity": "rim", "map": "AD.part[parttype = CNT | CPA]" } ], "max": "1", "min": 0, "path": "Organization.contact.address.district", "short": "District name (aka county)", "type": [ { "code": "string" } ] }, { "alias": [ "Province", "Territory" ], "base": { "max": "1", "min": 0, "path": "Address.state" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).", "id": "Organization.contact.address.state", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.4" }, { "identity": "rim", "map": "AD.part[parttype = STA]" }, { "identity": "vcard", "map": "region" }, { "identity": "servd", "map": "./Region" } ], "max": "1", "min": 0, "path": "Organization.contact.address.state", "short": "Sub-unit of country (abbreviations ok)", "type": [ { "code": "string" } ] }, { "alias": [ "Zip" ], "base": { "max": "1", "min": 0, "path": "Address.postalCode" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A postal code designating a region defined by the postal service.", "example": [ { "label": "General", "valueString": "9132" } ], "id": "Organization.contact.address.postalCode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.5" }, { "identity": "rim", "map": "AD.part[parttype = ZIP]" }, { "identity": "vcard", "map": "code" }, { "identity": "servd", "map": "./PostalIdentificationCode" } ], "max": "1", "min": 0, "path": "Organization.contact.address.postalCode", "short": "Postal code for area", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.country" }, "comment": "ISO 3166 3 letter codes can be used in place of a human readable country name.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Country - a nation as commonly understood or generally accepted.", "id": "Organization.contact.address.country", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.6" }, { "identity": "rim", "map": "AD.part[parttype = CNT]" }, { "identity": "vcard", "map": "country" }, { "identity": "servd", "map": "./Country" } ], "max": "1", "min": 0, "path": "Organization.contact.address.country", "short": "Country (e.g. can be ISO 3166 2 or 3 letter code)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Address.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period when address was/is in use.", "example": [ { "label": "General", "valuePeriod": { "end": "2010-07-01", "start": "2010-03-23" } } ], "id": "Organization.contact.address.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.12 / XAD.13 + XAD.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "1", "min": 0, "path": "Organization.contact.address.period", "requirements": "Allows addresses to be placed in historical context.", "short": "Time period when address was/is in use", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "Organization.endpoint" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Technical endpoints providing access to services operated for the organization.", "id": "Organization.endpoint", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Organization.endpoint", "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.", "short": "Technical endpoints providing access to services operated for the organization", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Endpoint" ] } ] } ] }, "status": "draft", "title": "OneHealth Organization", "type": "Organization", "url": "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/ObsRhFactorOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR ObsRhFactorOH Profile, for OH interoperability scenarios, based on the national CORE Observation Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Observation.identifier", "max": "0", "path": "Observation.identifier" }, { "id": "Observation.basedOn", "max": "0", "path": "Observation.basedOn" }, { "id": "Observation.partOf", "max": "0", "path": "Observation.partOf" }, { "definition": "Estado de la observación.Valor por defecto: final", "id": "Observation.status", "path": "Observation.status", "patternCode": "final", "short": "Estado de la observación. Valor por defecto: final" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "id": "Observation.category", "max": "1", "min": 1, "path": "Observation.category" }, { "id": "Observation.category.coding.system", "min": 1, "path": "Observation.category.coding.system" }, { "id": "Observation.category.coding.version", "max": "0", "path": "Observation.category.coding.version" }, { "fixedCode": "laboratory", "id": "Observation.category.coding.code", "min": 1, "path": "Observation.category.coding.code" }, { "id": "Observation.category.coding.display", "min": 1, "path": "Observation.category.coding.display" }, { "id": "Observation.category.coding.userSelected", "max": "0", "path": "Observation.category.coding.userSelected" }, { "id": "Observation.category.text", "max": "0", "path": "Observation.category.text" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "definition": "Código que identifica la observación como gfactor Rh.", "id": "Observation.code", "path": "Observation.code", "short": "Código que identifica la observación como factor Rh." }, { "id": "Observation.code.coding", "max": "1", "min": 1, "path": "Observation.code.coding" }, { "definition": "Sistema que define la codificación.Valor por defecto: http://loinc.org", "id": "Observation.code.coding.system", "min": 1, "path": "Observation.code.coding.system", "patternUri": "http://loinc.org", "short": "Sistema que define la codificación.Valor por defecto: http://loinc.org" }, { "id": "Observation.code.coding.version", "max": "0", "path": "Observation.code.coding.version" }, { "definition": "Código.Valor por defecto: 10331-7", "id": "Observation.code.coding.code", "min": 1, "path": "Observation.code.coding.code", "patternCode": "10331-7", "short": "Código.Valor por defecto: 10331-7" }, { "definition": "Descripción del código.Valor por defecto: Factor Rh", "id": "Observation.code.coding.display", "min": 1, "path": "Observation.code.coding.display", "patternString": "Descripción del código.Valor por defecto: Factor Rh", "short": "Factor Rh" }, { "id": "Observation.code.coding.userSelected", "max": "0", "path": "Observation.code.coding.userSelected" }, { "id": "Observation.code.text", "max": "0", "path": "Observation.code.text" }, { "id": "Observation.subject", "min": 1, "path": "Observation.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Observation.focus", "max": "0", "path": "Observation.focus" }, { "id": "Observation.encounter", "path": "Observation.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "min": 1, "path": "Observation.effective[x]", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]" }, { "id": "Observation.performer", "max": "1", "min": 1, "path": "Observation.performer", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/RhFactorsValueSetOH" }, "definition": "Example value 'RhD negative (finding)' [ES: Ejemplo de valor 'RhD negativo']", "id": "Observation.value[x]", "min": 1, "path": "Observation.value[x]", "short": "Example value 'RhD negative (finding)' [ES: Ejemplo de valor 'RhD negativo']", "type": [ { "code": "CodeableConcept" } ] }, { "id": "Observation.value[x].coding", "max": "1", "min": 1, "path": "Observation.value[x].coding" }, { "definition": "Sistema que define la codificación.Valor por defecto: http://snomed.info/sct", "id": "Observation.value[x].coding.system", "min": 1, "path": "Observation.value[x].coding.system", "short": "Sistema que define la codificación.Valor por defecto: http://snomed.info/sct" }, { "id": "Observation.value[x].coding.version", "max": "0", "path": "Observation.value[x].coding.version" }, { "definition": "Código.Valor de ejemplo: 165747007", "id": "Observation.value[x].coding.code", "min": 1, "path": "Observation.value[x].coding.code", "short": "Código.Valor de ejemplo: 165747007" }, { "definition": "Descripción del código.Valor de ejemplo: RhD positive (finding)\r\n", "id": "Observation.value[x].coding.display", "min": 1, "path": "Observation.value[x].coding.display", "short": "Descripción del código. Valor de ejemplo: RhD positive (finding)\r\n" }, { "id": "Observation.value[x].coding.userSelected", "max": "0", "path": "Observation.value[x].coding.userSelected" }, { "id": "Observation.value[x].text", "max": "0", "path": "Observation.value[x].text" }, { "id": "Observation.dataAbsentReason", "max": "0", "path": "Observation.dataAbsentReason" }, { "id": "Observation.interpretation", "max": "0", "path": "Observation.interpretation" }, { "id": "Observation.bodySite", "max": "0", "path": "Observation.bodySite" }, { "id": "Observation.method", "max": "0", "path": "Observation.method" }, { "id": "Observation.specimen", "max": "0", "path": "Observation.specimen" }, { "id": "Observation.device", "max": "0", "path": "Observation.device" }, { "id": "Observation.referenceRange", "max": "0", "path": "Observation.referenceRange" }, { "id": "Observation.hasMember", "max": "0", "path": "Observation.hasMember" }, { "id": "Observation.derivedFrom", "max": "0", "path": "Observation.derivedFrom" }, { "id": "Observation.component", "max": "0", "path": "Observation.component" } ] }, "fhirVersion": "4.0.1", "id": "ObsRhFactorOH", "jurisdiction": [ { "coding": [ { "code": "PER", "display": "Perú", "system": "urn:iso:std:iso:3166" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "sct-concept", "name": "SNOMED CT Concept Domain Binding", "uri": "http://snomed.info/conceptdomain" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "sct-attr", "name": "SNOMED CT Attribute Binding", "uri": "http://snomed.org/attributebinding" } ], "meta": { "lastUpdated": "2024-04-12T17:46:25.82468+00:00", "versionId": "MTcxMjk0Mzk4NTgyNDY4MDAwMA" }, "name": "ObsRhFactorOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Vital Signs", "Measurement", "Results", "Tests" ], "base": { "max": "*", "min": 0, "path": "Observation" }, "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.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "dataAbsentReason.empty() or value.empty()", "human": "dataAbsentReason SHALL only be present if Observation.value[x] is not present", "key": "obs-6", "severity": "error", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))" }, { "expression": "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", "human": "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", "key": "obs-7", "severity": "error", "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]))" } ], "definition": "Measurements and simple assertions made about a patient, device or other subject.", "id": "Observation", "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]" } ], "max": "*", "min": 0, "path": "Observation", "short": "Measurements and simple assertions" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Observation.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.implicitRules", "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, "max": "1", "min": 0, "path": "Observation.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Observation.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Observation.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Observation.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Observation.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A unique identifier assigned to this observation.", "id": "Observation.identifier", "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" } ], "max": "0", "min": 0, "path": "Observation.identifier", "requirements": "Allows observations to be distinguished and referenced.", "short": "Business Identifier for observation", "type": [ { "code": "Identifier" } ] }, { "alias": [ "Fulfills" ], "base": { "max": "*", "min": 0, "path": "Observation.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.basedOn", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "ORC" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.basedOn", "requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", "short": "Fulfills plan, proposal or order", "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" ] } ] }, { "alias": [ "Container" ], "base": { "max": "*", "min": 0, "path": "Observation.partOf" }, "comment": "To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", "id": "Observation.partOf", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target" } ], "max": "0", "min": 0, "path": "Observation.partOf", "short": "Part of referenced event", "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" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.status" }, "binding": { "description": "Codes providing the status of an observation.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-status|4.0.1" }, "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Estado de la observación.Valor por defecto: final", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final" } ], "id": "Observation.status", "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, "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\"" } ], "max": "1", "min": 1, "path": "Observation.status", "patternCode": "final", "requirements": "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", "short": "Estado de la observación. Valor por defecto: final", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.category" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the general type of observation being made.", "id": "Observation.category", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ], "max": "1", "min": 1, "path": "Observation.category", "requirements": "Used for filtering what observations are retrieved and displayed.", "short": "Classification of type of observation", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.category.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Observation.category.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Observation.category.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.category.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.category.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.category.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "fixedCode": "laboratory", "id": "Observation.category.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.category.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.category.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.category.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.category.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.category.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "Name" ], "base": { "max": "1", "min": 1, "path": "Observation.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código que identifica la observación como gfactor Rh.", "id": "Observation.code", "isModifier": false, "isSummary": true, "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|" } ], "max": "1", "min": 1, "path": "Observation.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Código que identifica la observación como factor Rh.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Observation.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Sistema que define la codificación.Valor por defecto: http://loinc.org", "id": "Observation.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.code.coding.system", "patternUri": "http://loinc.org", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Sistema que define la codificación.Valor por defecto: http://loinc.org", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código.Valor por defecto: 10331-7", "id": "Observation.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.code.coding.code", "patternCode": "10331-7", "requirements": "Need to refer to a particular code in the system.", "short": "Código.Valor por defecto: 10331-7", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Descripción del código.Valor por defecto: Factor Rh", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.code.coding.display", "patternString": "Descripción del código.Valor por defecto: Factor Rh", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Factor Rh", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.subject" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.subject", "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" } ], "max": "1", "min": 1, "path": "Observation.subject", "requirements": "Observations have no value if you don't know who or what they're about.", "short": "Who and/or what the observation is about", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "id": "Observation.focus", "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" } ], "max": "0", "min": 0, "path": "Observation.focus", "short": "What the observation is about, when it is not about the subject of record", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "alias": [ "Context" ], "base": { "max": "1", "min": 0, "path": "Observation.encounter" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", "id": "Observation.encounter", "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]" } ], "max": "1", "min": 0, "path": "Observation.encounter", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "short": "Healthcare event during which this observation is made", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "alias": [ "Occurrence" ], "base": { "max": "1", "min": 0, "path": "Observation.effective[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "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" } ], "max": "1", "min": 1, "path": "Observation.effective[x]", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.issued" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "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" } ], "max": "1", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "type": [ { "code": "instant" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.performer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who was responsible for asserting the observed value as \"true\".", "id": "Observation.performer", "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]" } ], "max": "1", "min": 1, "path": "Observation.performer", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "short": "Who is responsible for the observation", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.value[x]" }, "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/RhFactorsValueSetOH" }, "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.", "condition": [ "obs-7" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Example value 'RhD negative (finding)' [ES: Ejemplo de valor 'RhD negativo']", "id": "Observation.value[x]", "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|" } ], "max": "1", "min": 1, "path": "Observation.value[x]", "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.", "short": "Example value 'RhD negative (finding)' [ES: Ejemplo de valor 'RhD negativo']", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.value[x].id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.value[x].id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.value[x].extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.value[x].extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.value[x].coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Observation.value[x].coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.value[x].coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.value[x].coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.value[x].coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.value[x].coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Sistema que define la codificación.Valor por defecto: http://snomed.info/sct", "id": "Observation.value[x].coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.value[x].coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Sistema que define la codificación.Valor por defecto: http://snomed.info/sct", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.value[x].coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.value[x].coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código.Valor de ejemplo: 165747007", "id": "Observation.value[x].coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.value[x].coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Código.Valor de ejemplo: 165747007", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Descripción del código.Valor de ejemplo: RhD positive (finding)\r\n", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.value[x].coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.value[x].coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Descripción del código. Valor de ejemplo: RhD positive (finding)\r\n", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.value[x].coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.value[x].coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.value[x].text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.value[x].text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "id": "Observation.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "0", "min": 0, "path": "Observation.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "0", "min": 0, "path": "Observation.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.note" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Comments about the observation or the results.", "id": "Observation.note", "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" } ], "max": "*", "min": 0, "path": "Observation.note", "requirements": "Need to be able to provide free text additional information.", "short": "Comments about the observation", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.bodySite" }, "binding": { "description": "Codes describing anatomical locations. May include laterality.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the site on the subject's body where the observation was made (i.e. the target site).", "id": "Observation.bodySite", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 123037004 |Body structure|" }, { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": "targetSiteCode" }, { "identity": "sct-attr", "map": "718497002 |Inherent location|" } ], "max": "0", "min": 0, "path": "Observation.bodySite", "short": "Observed body part", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.method" }, "binding": { "description": "Methods for simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationMethod" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-methods" }, "comment": "Only used if not implicit in code for Observation.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the mechanism used to perform the observation.", "id": "Observation.method", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-17" }, { "identity": "rim", "map": "methodCode" } ], "max": "0", "min": 0, "path": "Observation.method", "requirements": "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", "short": "How it was done", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.specimen" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The specimen that was used when this observation was made.", "id": "Observation.specimen", "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|" } ], "max": "0", "min": 0, "path": "Observation.specimen", "short": "Specimen used for this observation", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.device" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The device used to generate the observation data.", "id": "Observation.device", "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|" } ], "max": "0", "min": 0, "path": "Observation.device", "short": "(Measurement) Device", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceMetric" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "low.exists() or high.exists() or text.exists()", "human": "Must have at least a low or a high or text", "key": "obs-3", "severity": "error", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))" } ], "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.", "id": "Observation.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.referenceRange", "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.", "short": "Provides guide for interpretation", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.referenceRange.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.referenceRange.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.referenceRange.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.low" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.low", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.low" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.high" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.high", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.high" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.type" }, "binding": { "description": "Code for the meaning of a reference range.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeMeaning" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-meaning" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", "id": "Observation.referenceRange.type", "isModifier": false, "isSummary": false, "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" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.type", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.", "short": "Reference range qualifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo" }, "binding": { "description": "Codes identifying the population the reference range applies to.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-appliesto" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.appliesTo", "isModifier": false, "isSummary": false, "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo", "requirements": "Need to be able to identify the target population for proper interpretation.", "short": "Reference range population", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.age" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.age", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.age", "requirements": "Some analytes vary greatly over age.", "short": "Applicable age range, if relevant", "type": [ { "code": "Range" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.text" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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\".", "id": "Observation.referenceRange.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:ST" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.hasMember" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.hasMember", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": "outBoundRelationship" } ], "max": "0", "min": 0, "path": "Observation.hasMember", "short": "Related resource that belongs to the Observation group", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", "http://hl7.org/fhir/StructureDefinition/MolecularSequence" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.derivedFrom" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.derivedFrom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": ".targetObservation" } ], "max": "0", "min": 0, "path": "Observation.derivedFrom", "short": "Related measurements the observation is made from", "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" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component" }, "comment": "For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.component", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "containment by OBX-4?" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=COMP]" } ], "max": "0", "min": 0, "path": "Observation.component", "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.", "short": "Component results", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.component.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.component.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.component.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.component.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.component.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.component.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.component.code" }, "binding": { "description": "Codes identifying names of simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCode" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "comment": "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "id": "Observation.component.code", "isModifier": false, "isSummary": true, "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" } ], "max": "1", "min": 1, "path": "Observation.component.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Type of component observation (code / type)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.value[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The information determined as a result of making the observation, if the information has a simple value.", "id": "Observation.component.value[x]", "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|" } ], "max": "1", "min": 0, "path": "Observation.component.value[x]", "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.", "short": "Actual component result", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", "id": "Observation.component.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the component result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.component.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.component.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "*", "min": 0, "path": "Observation.component.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Observation.referenceRange", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.", "id": "Observation.component.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "*", "min": 0, "path": "Observation.component.referenceRange", "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.", "short": "Provides guide for interpretation of component result" } ] }, "status": "draft", "title": "OneHealth ObsRhFactor", "type": "Observation", "url": "https://fhir.onehealth.com.pe/StructureDefinition/ObsRhFactorOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/ObsRecommendationToRestOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-15", "derivation": "constraint", "description": "FHIR ObsRecommendationToRestOH Profile, for OH interoperability scenarios, based on the national CORE Observation Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Observation.identifier", "max": "0", "path": "Observation.identifier" }, { "id": "Observation.basedOn", "max": "0", "path": "Observation.basedOn" }, { "id": "Observation.partOf", "max": "0", "path": "Observation.partOf" }, { "definition": "Estado de la observación.\r\nValor por defecto: final", "id": "Observation.status", "path": "Observation.status", "patternCode": "final", "short": "Estado de la observación.\r\nValor por defecto: final" }, { "id": "Observation.category", "max": "0", "path": "Observation.category" }, { "definition": "Código que identifica la observación como el período de descanso médico.", "id": "Observation.code", "path": "Observation.code", "short": "Código que identifica la observación como el período de descanso médico." }, { "id": "Observation.code.coding", "max": "1", "min": 1, "path": "Observation.code.coding" }, { "definition": "Sistema que define la codificación.\r\nValor por defecto: http://snomed.info/sct", "id": "Observation.code.coding.system", "min": 1, "path": "Observation.code.coding.system", "patternUri": "http://snomed.info/sct", "short": "Sistema que define la codificación.\r\nValor por defecto: http://snomed.info/sct" }, { "id": "Observation.code.coding.version", "max": "0", "path": "Observation.code.coding.version" }, { "definition": "Código.\r\nValor por defecto: 183051005", "fixedCode": "183051005", "id": "Observation.code.coding.code", "min": 1, "path": "Observation.code.coding.code", "short": "Código.\r\nValor por defecto: 183051005" }, { "definition": "Descripción del código.\r\nValor por defecto: recomendación para hacer reposo (procedimiento)", "id": "Observation.code.coding.display", "min": 1, "path": "Observation.code.coding.display", "patternString": "recomendación para hacer reposo (procedimiento)", "short": "Descripción del código.\r\nValor por defecto: recomendación para hacer reposo (procedimiento)" }, { "id": "Observation.code.coding.userSelected", "max": "0", "path": "Observation.code.coding.userSelected" }, { "id": "Observation.code.text", "max": "0", "path": "Observation.code.text" }, { "id": "Observation.subject", "path": "Observation.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Observation.focus", "max": "0", "path": "Observation.focus" }, { "id": "Observation.encounter", "path": "Observation.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "path": "Observation.effective[x]", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]" }, { "id": "Observation.performer", "path": "Observation.performer", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "Observation.value[x]", "min": 1, "path": "Observation.value[x]", "type": [ { "code": "Period" } ] }, { "definition": "Example value '2019-12-20' [ES: Ejemplo del valor '2019-12-20']", "id": "Observation.value[x].start", "min": 1, "path": "Observation.value[x].start", "short": "Example value '2019-12-20' [ES: Ejemplo del valor '2019-12-20']" }, { "definition": "Example value '2019-12-25' [ES: Ejemplo del valor '2019-12-25']", "id": "Observation.value[x].end", "min": 1, "path": "Observation.value[x].end", "short": "Example value '2019-12-25' [ES: Ejemplo del valor '2019-12-25']" }, { "id": "Observation.dataAbsentReason", "max": "0", "path": "Observation.dataAbsentReason" }, { "id": "Observation.interpretation", "max": "0", "path": "Observation.interpretation" }, { "id": "Observation.bodySite", "max": "0", "path": "Observation.bodySite" }, { "id": "Observation.method", "max": "0", "path": "Observation.method" }, { "id": "Observation.specimen", "max": "0", "path": "Observation.specimen" }, { "id": "Observation.device", "max": "0", "path": "Observation.device" }, { "id": "Observation.referenceRange", "max": "0", "path": "Observation.referenceRange" }, { "id": "Observation.hasMember", "max": "0", "path": "Observation.hasMember" }, { "id": "Observation.derivedFrom", "max": "0", "path": "Observation.derivedFrom" }, { "id": "Observation.component", "max": "0", "path": "Observation.component" } ] }, "fhirVersion": "4.0.1", "id": "ObsRecommendationToRestOH", "jurisdiction": [ { "coding": [ { "code": "PER", "display": "Perú", "system": "urn:iso:std:iso:3166" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "sct-concept", "name": "SNOMED CT Concept Domain Binding", "uri": "http://snomed.info/conceptdomain" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "sct-attr", "name": "SNOMED CT Attribute Binding", "uri": "http://snomed.org/attributebinding" } ], "meta": { "lastUpdated": "2024-04-12T17:46:25.578413+00:00", "versionId": "MTcxMjk0Mzk4NTU3ODQxMzAwMA" }, "name": "ObsRecommendationToRestOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Vital Signs", "Measurement", "Results", "Tests" ], "base": { "max": "*", "min": 0, "path": "Observation" }, "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.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "dataAbsentReason.empty() or value.empty()", "human": "dataAbsentReason SHALL only be present if Observation.value[x] is not present", "key": "obs-6", "severity": "error", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))" }, { "expression": "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", "human": "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", "key": "obs-7", "severity": "error", "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]))" } ], "definition": "Measurements and simple assertions made about a patient, device or other subject.", "id": "Observation", "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]" } ], "max": "*", "min": 0, "path": "Observation", "short": "Measurements and simple assertions" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Observation.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.implicitRules", "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, "max": "1", "min": 0, "path": "Observation.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Observation.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Observation.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Observation.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Observation.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A unique identifier assigned to this observation.", "id": "Observation.identifier", "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" } ], "max": "0", "min": 0, "path": "Observation.identifier", "requirements": "Allows observations to be distinguished and referenced.", "short": "Business Identifier for observation", "type": [ { "code": "Identifier" } ] }, { "alias": [ "Fulfills" ], "base": { "max": "*", "min": 0, "path": "Observation.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.basedOn", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "ORC" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.basedOn", "requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", "short": "Fulfills plan, proposal or order", "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" ] } ] }, { "alias": [ "Container" ], "base": { "max": "*", "min": 0, "path": "Observation.partOf" }, "comment": "To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", "id": "Observation.partOf", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target" } ], "max": "0", "min": 0, "path": "Observation.partOf", "short": "Part of referenced event", "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" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.status" }, "binding": { "description": "Codes providing the status of an observation.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-status|4.0.1" }, "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Estado de la observación.\r\nValor por defecto: final", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final" } ], "id": "Observation.status", "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, "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\"" } ], "max": "1", "min": 1, "path": "Observation.status", "patternCode": "final", "requirements": "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", "short": "Estado de la observación.\r\nValor por defecto: final", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.category" }, "binding": { "description": "Codes for high level observation categories.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCategory" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the general type of observation being made.", "id": "Observation.category", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ], "max": "0", "min": 0, "path": "Observation.category", "requirements": "Used for filtering what observations are retrieved and displayed.", "short": "Classification of type of observation", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Name" ], "base": { "max": "1", "min": 1, "path": "Observation.code" }, "binding": { "description": "Codes identifying names of simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCode" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código que identifica la observación como el período de descanso médico.", "id": "Observation.code", "isModifier": false, "isSummary": true, "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|" } ], "max": "1", "min": 1, "path": "Observation.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Código que identifica la observación como el período de descanso médico.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Observation.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Sistema que define la codificación.\r\nValor por defecto: http://snomed.info/sct", "id": "Observation.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.code.coding.system", "patternUri": "http://snomed.info/sct", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Sistema que define la codificación.\r\nValor por defecto: http://snomed.info/sct", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código.\r\nValor por defecto: 183051005", "fixedCode": "183051005", "id": "Observation.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.code.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Código.\r\nValor por defecto: 183051005", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Descripción del código.\r\nValor por defecto: recomendación para hacer reposo (procedimiento)", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.code.coding.display", "patternString": "recomendación para hacer reposo (procedimiento)", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Descripción del código.\r\nValor por defecto: recomendación para hacer reposo (procedimiento)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.subject" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.subject", "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" } ], "max": "1", "min": 0, "path": "Observation.subject", "requirements": "Observations have no value if you don't know who or what they're about.", "short": "Who and/or what the observation is about", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "id": "Observation.focus", "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" } ], "max": "0", "min": 0, "path": "Observation.focus", "short": "What the observation is about, when it is not about the subject of record", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "alias": [ "Context" ], "base": { "max": "1", "min": 0, "path": "Observation.encounter" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", "id": "Observation.encounter", "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]" } ], "max": "1", "min": 0, "path": "Observation.encounter", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "short": "Healthcare event during which this observation is made", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "alias": [ "Occurrence" ], "base": { "max": "1", "min": 0, "path": "Observation.effective[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "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" } ], "max": "1", "min": 0, "path": "Observation.effective[x]", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.issued" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "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" } ], "max": "1", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "type": [ { "code": "instant" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.performer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who was responsible for asserting the observed value as \"true\".", "id": "Observation.performer", "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]" } ], "max": "*", "min": 0, "path": "Observation.performer", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "short": "Who is responsible for the observation", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.value[x]" }, "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.", "condition": [ "obs-7" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The information determined as a result of making the observation, if the information has a simple value.", "id": "Observation.value[x]", "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|" } ], "max": "1", "min": 1, "path": "Observation.value[x]", "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.", "short": "Actual result", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.value[x].id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.value[x].id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.value[x].extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.value[x].extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.start" }, "comment": "If the low element is missing, the meaning is that the low boundary is not known.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Example value '2019-12-20' [ES: Ejemplo del valor '2019-12-20']", "id": "Observation.value[x].start", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ], "max": "1", "min": 1, "path": "Observation.value[x].start", "short": "Example value '2019-12-20' [ES: Ejemplo del valor '2019-12-20']", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.end" }, "comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Example value '2019-12-25' [ES: Ejemplo del valor '2019-12-25']", "id": "Observation.value[x].end", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ], "max": "1", "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "min": 1, "path": "Observation.value[x].end", "short": "Example value '2019-12-25' [ES: Ejemplo del valor '2019-12-25']", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "id": "Observation.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "0", "min": 0, "path": "Observation.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "0", "min": 0, "path": "Observation.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.note" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Comments about the observation or the results.", "id": "Observation.note", "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" } ], "max": "*", "min": 0, "path": "Observation.note", "requirements": "Need to be able to provide free text additional information.", "short": "Comments about the observation", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.bodySite" }, "binding": { "description": "Codes describing anatomical locations. May include laterality.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the site on the subject's body where the observation was made (i.e. the target site).", "id": "Observation.bodySite", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 123037004 |Body structure|" }, { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": "targetSiteCode" }, { "identity": "sct-attr", "map": "718497002 |Inherent location|" } ], "max": "0", "min": 0, "path": "Observation.bodySite", "short": "Observed body part", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.method" }, "binding": { "description": "Methods for simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationMethod" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-methods" }, "comment": "Only used if not implicit in code for Observation.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the mechanism used to perform the observation.", "id": "Observation.method", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-17" }, { "identity": "rim", "map": "methodCode" } ], "max": "0", "min": 0, "path": "Observation.method", "requirements": "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", "short": "How it was done", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.specimen" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The specimen that was used when this observation was made.", "id": "Observation.specimen", "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|" } ], "max": "0", "min": 0, "path": "Observation.specimen", "short": "Specimen used for this observation", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.device" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The device used to generate the observation data.", "id": "Observation.device", "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|" } ], "max": "0", "min": 0, "path": "Observation.device", "short": "(Measurement) Device", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceMetric" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "low.exists() or high.exists() or text.exists()", "human": "Must have at least a low or a high or text", "key": "obs-3", "severity": "error", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))" } ], "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.", "id": "Observation.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.referenceRange", "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.", "short": "Provides guide for interpretation", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.referenceRange.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.referenceRange.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.referenceRange.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.low" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.low", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.low" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.high" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.high", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.high" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.type" }, "binding": { "description": "Code for the meaning of a reference range.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeMeaning" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-meaning" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", "id": "Observation.referenceRange.type", "isModifier": false, "isSummary": false, "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" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.type", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.", "short": "Reference range qualifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo" }, "binding": { "description": "Codes identifying the population the reference range applies to.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-appliesto" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.appliesTo", "isModifier": false, "isSummary": false, "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo", "requirements": "Need to be able to identify the target population for proper interpretation.", "short": "Reference range population", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.age" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.age", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.age", "requirements": "Some analytes vary greatly over age.", "short": "Applicable age range, if relevant", "type": [ { "code": "Range" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.text" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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\".", "id": "Observation.referenceRange.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:ST" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.hasMember" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.hasMember", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": "outBoundRelationship" } ], "max": "0", "min": 0, "path": "Observation.hasMember", "short": "Related resource that belongs to the Observation group", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", "http://hl7.org/fhir/StructureDefinition/MolecularSequence" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.derivedFrom" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.derivedFrom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": ".targetObservation" } ], "max": "0", "min": 0, "path": "Observation.derivedFrom", "short": "Related measurements the observation is made from", "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" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component" }, "comment": "For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.component", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "containment by OBX-4?" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=COMP]" } ], "max": "0", "min": 0, "path": "Observation.component", "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.", "short": "Component results", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.component.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.component.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.component.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.component.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.component.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.component.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.component.code" }, "binding": { "description": "Codes identifying names of simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCode" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "comment": "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "id": "Observation.component.code", "isModifier": false, "isSummary": true, "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" } ], "max": "1", "min": 1, "path": "Observation.component.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Type of component observation (code / type)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.value[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The information determined as a result of making the observation, if the information has a simple value.", "id": "Observation.component.value[x]", "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|" } ], "max": "1", "min": 0, "path": "Observation.component.value[x]", "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.", "short": "Actual component result", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", "id": "Observation.component.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the component result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.component.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.component.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "*", "min": 0, "path": "Observation.component.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Observation.referenceRange", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.", "id": "Observation.component.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "*", "min": 0, "path": "Observation.component.referenceRange", "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.", "short": "Provides guide for interpretation of component result" } ] }, "status": "draft", "title": "OneHealth ObsRecommendationToRestOH", "type": "Observation", "url": "https://fhir.onehealth.com.pe/StructureDefinition/ObsRecommendationToRestOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/ObsNumberOfStepsOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR ObsNumberOfStepsOH Profile, for OH interoperability scenarios, based on the national CORE Observation Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Observation.identifier", "max": "0", "path": "Observation.identifier" }, { "id": "Observation.basedOn", "max": "0", "path": "Observation.basedOn" }, { "id": "Observation.partOf", "max": "0", "path": "Observation.partOf" }, { "definition": "Estado de la observación.Valor por defecto: final", "id": "Observation.status", "path": "Observation.status", "patternCode": "final", "short": "Estado de la observación. Valor por defecto: final" }, { "id": "Observation.category", "max": "1", "min": 1, "path": "Observation.category" }, { "binding": { "strength": "required", "valueSet": "https://hl7.org/fhir/R4/valueset-observation-category.html" }, "id": "Observation.category.coding.system", "min": 1, "path": "Observation.category.coding.system" }, { "id": "Observation.category.coding.version", "max": "0", "path": "Observation.category.coding.version" }, { "fixedCode": "activity", "id": "Observation.category.coding.code", "min": 1, "path": "Observation.category.coding.code" }, { "id": "Observation.category.coding.display", "min": 1, "path": "Observation.category.coding.display" }, { "id": "Observation.category.coding.userSelected", "max": "0", "path": "Observation.category.coding.userSelected" }, { "id": "Observation.category.text", "max": "0", "path": "Observation.category.text" }, { "definition": "Código que identifica la observación como la cantidad de pasos diarios.", "id": "Observation.code", "path": "Observation.code", "short": "Código que identifica la observación como la cantidad de pasos diarios." }, { "id": "Observation.code.coding", "max": "1", "min": 1, "path": "Observation.code.coding" }, { "id": "Observation.code.coding.system", "min": 1, "path": "Observation.code.coding.system", "patternUri": "http://loinc.org" }, { "id": "Observation.code.coding.version", "max": "0", "path": "Observation.code.coding.version" }, { "definition": "Código.Valor por defecto: 41950-7", "id": "Observation.code.coding.code", "min": 1, "path": "Observation.code.coding.code", "patternCode": "41950-7", "short": "Código.Valor por defecto: 41950-7" }, { "id": "Observation.code.coding.display", "min": 1, "path": "Observation.code.coding.display", "patternString": "Numero de pasos en 24 hs" }, { "id": "Observation.code.coding.userSelected", "max": "0", "path": "Observation.code.coding.userSelected" }, { "id": "Observation.code.text", "max": "0", "path": "Observation.code.text" }, { "id": "Observation.subject", "min": 1, "path": "Observation.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Observation.focus", "max": "0", "path": "Observation.focus" }, { "id": "Observation.encounter", "path": "Observation.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "min": 1, "path": "Observation.effective[x]", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]" }, { "id": "Observation.performer", "max": "1", "path": "Observation.performer", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "Observation.value[x]", "min": 1, "path": "Observation.value[x]", "type": [ { "code": "Quantity" } ] }, { "definition": "Example value '2345' [ES: Ejemplo de valor '2345']", "id": "Observation.value[x].value", "path": "Observation.value[x].value", "short": "Example value '2345' [ES: Ejemplo de valor '2345']" }, { "id": "Observation.value[x].comparator", "max": "0", "path": "Observation.value[x].comparator" }, { "id": "Observation.value[x].unit", "max": "0", "path": "Observation.value[x].unit" }, { "id": "Observation.value[x].system", "max": "0", "path": "Observation.value[x].system" }, { "id": "Observation.value[x].code", "max": "0", "path": "Observation.value[x].code" }, { "id": "Observation.dataAbsentReason", "max": "0", "path": "Observation.dataAbsentReason" }, { "id": "Observation.interpretation", "max": "0", "path": "Observation.interpretation" }, { "id": "Observation.bodySite", "max": "0", "path": "Observation.bodySite" }, { "id": "Observation.method", "max": "0", "path": "Observation.method" }, { "id": "Observation.specimen", "max": "0", "path": "Observation.specimen" }, { "id": "Observation.device", "max": "0", "path": "Observation.device" }, { "id": "Observation.referenceRange", "max": "0", "path": "Observation.referenceRange" }, { "id": "Observation.hasMember", "max": "0", "path": "Observation.hasMember" }, { "id": "Observation.derivedFrom", "max": "0", "path": "Observation.derivedFrom" }, { "id": "Observation.component", "max": "0", "path": "Observation.component" } ] }, "fhirVersion": "4.0.1", "id": "ObsNumberOfStepsOH", "jurisdiction": [ { "coding": [ { "code": "PER", "display": "Perú", "system": "urn:iso:std:iso:3166" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "sct-concept", "name": "SNOMED CT Concept Domain Binding", "uri": "http://snomed.info/conceptdomain" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "sct-attr", "name": "SNOMED CT Attribute Binding", "uri": "http://snomed.org/attributebinding" } ], "meta": { "lastUpdated": "2024-04-12T17:46:25.394394+00:00", "versionId": "MTcxMjk0Mzk4NTM5NDM5NDAwMA" }, "name": "ObsNumberOfStepsOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Vital Signs", "Measurement", "Results", "Tests" ], "base": { "max": "*", "min": 0, "path": "Observation" }, "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.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "dataAbsentReason.empty() or value.empty()", "human": "dataAbsentReason SHALL only be present if Observation.value[x] is not present", "key": "obs-6", "severity": "error", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))" }, { "expression": "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", "human": "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", "key": "obs-7", "severity": "error", "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]))" } ], "definition": "Measurements and simple assertions made about a patient, device or other subject.", "id": "Observation", "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]" } ], "max": "*", "min": 0, "path": "Observation", "short": "Measurements and simple assertions" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Observation.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.implicitRules", "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, "max": "1", "min": 0, "path": "Observation.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Observation.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Observation.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Observation.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Observation.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A unique identifier assigned to this observation.", "id": "Observation.identifier", "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" } ], "max": "0", "min": 0, "path": "Observation.identifier", "requirements": "Allows observations to be distinguished and referenced.", "short": "Business Identifier for observation", "type": [ { "code": "Identifier" } ] }, { "alias": [ "Fulfills" ], "base": { "max": "*", "min": 0, "path": "Observation.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.basedOn", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "ORC" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.basedOn", "requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", "short": "Fulfills plan, proposal or order", "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" ] } ] }, { "alias": [ "Container" ], "base": { "max": "*", "min": 0, "path": "Observation.partOf" }, "comment": "To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", "id": "Observation.partOf", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target" } ], "max": "0", "min": 0, "path": "Observation.partOf", "short": "Part of referenced event", "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" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.status" }, "binding": { "description": "Codes providing the status of an observation.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-status|4.0.1" }, "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Estado de la observación.Valor por defecto: final", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final" } ], "id": "Observation.status", "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, "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\"" } ], "max": "1", "min": 1, "path": "Observation.status", "patternCode": "final", "requirements": "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", "short": "Estado de la observación. Valor por defecto: final", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.category" }, "binding": { "description": "Codes for high level observation categories.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCategory" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the general type of observation being made.", "id": "Observation.category", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ], "max": "1", "min": 1, "path": "Observation.category", "requirements": "Used for filtering what observations are retrieved and displayed.", "short": "Classification of type of observation", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.category.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Observation.category.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "binding": { "strength": "required", "valueSet": "https://hl7.org/fhir/R4/valueset-observation-category.html" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Observation.category.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.category.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.category.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.category.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "fixedCode": "activity", "id": "Observation.category.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.category.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.category.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.category.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.category.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.category.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "Name" ], "base": { "max": "1", "min": 1, "path": "Observation.code" }, "binding": { "description": "Codes identifying names of simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCode" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código que identifica la observación como la cantidad de pasos diarios.", "id": "Observation.code", "isModifier": false, "isSummary": true, "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|" } ], "max": "1", "min": 1, "path": "Observation.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Código que identifica la observación como la cantidad de pasos diarios.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Observation.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Observation.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.code.coding.system", "patternUri": "http://loinc.org", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código.Valor por defecto: 41950-7", "id": "Observation.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.code.coding.code", "patternCode": "41950-7", "requirements": "Need to refer to a particular code in the system.", "short": "Código.Valor por defecto: 41950-7", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.code.coding.display", "patternString": "Numero de pasos en 24 hs", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.subject" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.subject", "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" } ], "max": "1", "min": 1, "path": "Observation.subject", "requirements": "Observations have no value if you don't know who or what they're about.", "short": "Who and/or what the observation is about", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "id": "Observation.focus", "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" } ], "max": "0", "min": 0, "path": "Observation.focus", "short": "What the observation is about, when it is not about the subject of record", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "alias": [ "Context" ], "base": { "max": "1", "min": 0, "path": "Observation.encounter" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", "id": "Observation.encounter", "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]" } ], "max": "1", "min": 0, "path": "Observation.encounter", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "short": "Healthcare event during which this observation is made", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "alias": [ "Occurrence" ], "base": { "max": "1", "min": 0, "path": "Observation.effective[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "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" } ], "max": "1", "min": 1, "path": "Observation.effective[x]", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.issued" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "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" } ], "max": "1", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "type": [ { "code": "instant" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.performer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who was responsible for asserting the observed value as \"true\".", "id": "Observation.performer", "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]" } ], "max": "1", "min": 0, "path": "Observation.performer", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "short": "Who is responsible for the observation", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.value[x]" }, "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.", "condition": [ "obs-7" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The information determined as a result of making the observation, if the information has a simple value.", "id": "Observation.value[x]", "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|" } ], "max": "1", "min": 1, "path": "Observation.value[x]", "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.", "short": "Actual result", "type": [ { "code": "Quantity" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.value[x].id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.value[x].id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.value[x].extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.value[x].extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.value" }, "comment": "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Example value '2345' [ES: Ejemplo de valor '2345']", "id": "Observation.value[x].value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "SN.2 / CQ - N/A" }, { "identity": "rim", "map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value" } ], "max": "1", "min": 0, "path": "Observation.value[x].value", "requirements": "Precision is handled implicitly in almost all cases of measurement.", "short": "Example value '2345' [ES: Ejemplo de valor '2345']", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.comparator" }, "binding": { "description": "How the Quantity should be understood and represented.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuantityComparator" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.", "id": "Observation.value[x].comparator", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value", "isSummary": true, "mapping": [ { "identity": "v2", "map": "SN.1 / CQ.1" }, { "identity": "rim", "map": "IVL properties" } ], "max": "0", "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "min": 0, "path": "Observation.value[x].comparator", "requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.", "short": "< | <= | >= | > - how to understand the value", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.unit" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable form of the unit.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.value[x].unit", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ], "max": "0", "min": 0, "path": "Observation.value[x].unit", "requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.", "short": "Unit representation", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.system" }, "condition": [ "qty-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the system that provides the coded form of the unit.", "id": "Observation.value[x].system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "CO.codeSystem, PQ.translation.codeSystem" } ], "max": "0", "min": 0, "path": "Observation.value[x].system", "requirements": "Need to know the system that defines the coded form of the unit.", "short": "System that defines coded unit form", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.code" }, "comment": "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A computer processable form of the unit in some unit representation system.", "id": "Observation.value[x].code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.code, MO.currency, PQ.translation.code" } ], "max": "0", "min": 0, "path": "Observation.value[x].code", "requirements": "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.", "short": "Coded form of the unit", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "id": "Observation.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "0", "min": 0, "path": "Observation.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "0", "min": 0, "path": "Observation.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.note" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Comments about the observation or the results.", "id": "Observation.note", "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" } ], "max": "*", "min": 0, "path": "Observation.note", "requirements": "Need to be able to provide free text additional information.", "short": "Comments about the observation", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.bodySite" }, "binding": { "description": "Codes describing anatomical locations. May include laterality.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the site on the subject's body where the observation was made (i.e. the target site).", "id": "Observation.bodySite", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 123037004 |Body structure|" }, { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": "targetSiteCode" }, { "identity": "sct-attr", "map": "718497002 |Inherent location|" } ], "max": "0", "min": 0, "path": "Observation.bodySite", "short": "Observed body part", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.method" }, "binding": { "description": "Methods for simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationMethod" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-methods" }, "comment": "Only used if not implicit in code for Observation.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the mechanism used to perform the observation.", "id": "Observation.method", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-17" }, { "identity": "rim", "map": "methodCode" } ], "max": "0", "min": 0, "path": "Observation.method", "requirements": "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", "short": "How it was done", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.specimen" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The specimen that was used when this observation was made.", "id": "Observation.specimen", "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|" } ], "max": "0", "min": 0, "path": "Observation.specimen", "short": "Specimen used for this observation", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.device" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The device used to generate the observation data.", "id": "Observation.device", "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|" } ], "max": "0", "min": 0, "path": "Observation.device", "short": "(Measurement) Device", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceMetric" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "low.exists() or high.exists() or text.exists()", "human": "Must have at least a low or a high or text", "key": "obs-3", "severity": "error", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))" } ], "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.", "id": "Observation.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.referenceRange", "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.", "short": "Provides guide for interpretation", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.referenceRange.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.referenceRange.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.referenceRange.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.low" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.low", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.low" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.high" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.high", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.high" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.type" }, "binding": { "description": "Code for the meaning of a reference range.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeMeaning" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-meaning" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", "id": "Observation.referenceRange.type", "isModifier": false, "isSummary": false, "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" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.type", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.", "short": "Reference range qualifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo" }, "binding": { "description": "Codes identifying the population the reference range applies to.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-appliesto" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.appliesTo", "isModifier": false, "isSummary": false, "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo", "requirements": "Need to be able to identify the target population for proper interpretation.", "short": "Reference range population", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.age" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.age", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.age", "requirements": "Some analytes vary greatly over age.", "short": "Applicable age range, if relevant", "type": [ { "code": "Range" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.text" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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\".", "id": "Observation.referenceRange.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:ST" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.hasMember" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.hasMember", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": "outBoundRelationship" } ], "max": "0", "min": 0, "path": "Observation.hasMember", "short": "Related resource that belongs to the Observation group", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", "http://hl7.org/fhir/StructureDefinition/MolecularSequence" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.derivedFrom" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.derivedFrom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": ".targetObservation" } ], "max": "0", "min": 0, "path": "Observation.derivedFrom", "short": "Related measurements the observation is made from", "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" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component" }, "comment": "For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.component", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "containment by OBX-4?" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=COMP]" } ], "max": "0", "min": 0, "path": "Observation.component", "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.", "short": "Component results", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.component.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.component.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.component.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.component.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.component.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.component.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.component.code" }, "binding": { "description": "Codes identifying names of simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCode" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "comment": "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "id": "Observation.component.code", "isModifier": false, "isSummary": true, "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" } ], "max": "1", "min": 1, "path": "Observation.component.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Type of component observation (code / type)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.value[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The information determined as a result of making the observation, if the information has a simple value.", "id": "Observation.component.value[x]", "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|" } ], "max": "1", "min": 0, "path": "Observation.component.value[x]", "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.", "short": "Actual component result", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", "id": "Observation.component.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the component result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.component.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.component.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "*", "min": 0, "path": "Observation.component.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Observation.referenceRange", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.", "id": "Observation.component.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "*", "min": 0, "path": "Observation.component.referenceRange", "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.", "short": "Provides guide for interpretation of component result" } ] }, "status": "draft", "title": "OneHealth ObsNumberOfSteps", "type": "Observation", "url": "https://fhir.onehealth.com.pe/StructureDefinition/ObsNumberOfStepsOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/ObsLastMenstrualPeriodOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-15", "derivation": "constraint", "description": "FHIR ObsLastMenstrualPeriodOH Profile, for OH interoperability scenarios, based on the national CORE Observation Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Observation.identifier", "max": "0", "path": "Observation.identifier" }, { "id": "Observation.basedOn", "max": "0", "path": "Observation.basedOn" }, { "id": "Observation.partOf", "max": "0", "path": "Observation.partOf" }, { "definition": "Estado de la observación.\r\nValor por defecto: final", "id": "Observation.status", "path": "Observation.status", "patternCode": "final", "short": "Estado de la observación.\r\nValor por defecto: final" }, { "id": "Observation.category", "max": "0", "path": "Observation.category" }, { "definition": "Código que identifica la observación como el último periodo menstrual.", "id": "Observation.code", "path": "Observation.code", "short": "Código que identifica la observación como el último periodo menstrual." }, { "id": "Observation.code.coding", "max": "1", "min": 1, "path": "Observation.code.coding" }, { "definition": "Sistema que define la codificación.\r\nValor por defecto: http://snomed.info/sct", "id": "Observation.code.coding.system", "min": 1, "path": "Observation.code.coding.system", "patternUri": "http://snomed.info/sct", "short": "Sistema que define la codificación.\r\nValor por defecto: http://snomed.info/sct" }, { "id": "Observation.code.coding.version", "max": "0", "path": "Observation.code.coding.version" }, { "definition": "Código.\r\nValor por defecto: 21840007", "id": "Observation.code.coding.code", "min": 1, "path": "Observation.code.coding.code", "patternCode": "21840007", "short": "Código.\r\nValor por defecto: 21840007" }, { "definition": "Descripción del código.\r\nValor por defecto: Último periodo menstrual", "id": "Observation.code.coding.display", "min": 1, "path": "Observation.code.coding.display", "patternString": "Último periodo menstrual", "short": "Descripción del código.\r\nValor por defecto: Último periodo menstrual" }, { "id": "Observation.code.coding.userSelected", "max": "0", "path": "Observation.code.coding.userSelected" }, { "id": "Observation.code.text", "max": "0", "path": "Observation.code.text" }, { "id": "Observation.subject", "path": "Observation.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Observation.focus", "max": "0", "path": "Observation.focus" }, { "id": "Observation.encounter", "path": "Observation.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "path": "Observation.effective[x]", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]" }, { "id": "Observation.performer", "max": "1", "min": 1, "path": "Observation.performer", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH", "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "definition": "Example value '2023-12-20' [ES: Ejemplo del valor '2023-12-20']", "id": "Observation.value[x]", "min": 1, "path": "Observation.value[x]", "short": "Example value '2023-12-20' [ES: Ejemplo del valor '2019-12-20']", "type": [ { "code": "dateTime" } ] }, { "id": "Observation.dataAbsentReason", "max": "0", "path": "Observation.dataAbsentReason" }, { "id": "Observation.interpretation", "max": "0", "path": "Observation.interpretation" }, { "id": "Observation.bodySite", "max": "0", "path": "Observation.bodySite" }, { "id": "Observation.method", "max": "0", "path": "Observation.method" }, { "id": "Observation.specimen", "max": "0", "path": "Observation.specimen" }, { "id": "Observation.device", "max": "0", "path": "Observation.device" }, { "id": "Observation.referenceRange", "max": "0", "path": "Observation.referenceRange" }, { "id": "Observation.hasMember", "max": "0", "path": "Observation.hasMember" }, { "id": "Observation.derivedFrom", "max": "0", "path": "Observation.derivedFrom" }, { "id": "Observation.component", "max": "0", "path": "Observation.component" } ] }, "fhirVersion": "4.0.1", "id": "ObsLastMenstrualPeriodOH", "jurisdiction": [ { "coding": [ { "code": "PER", "display": "Perú", "system": "urn:iso:std:iso:3166" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "sct-concept", "name": "SNOMED CT Concept Domain Binding", "uri": "http://snomed.info/conceptdomain" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "sct-attr", "name": "SNOMED CT Attribute Binding", "uri": "http://snomed.org/attributebinding" } ], "meta": { "lastUpdated": "2024-04-12T17:46:25.111963+00:00", "versionId": "MTcxMjk0Mzk4NTExMTk2MzAwMA" }, "name": "ObsLastMenstrualPeriodOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Vital Signs", "Measurement", "Results", "Tests" ], "base": { "max": "*", "min": 0, "path": "Observation" }, "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.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "dataAbsentReason.empty() or value.empty()", "human": "dataAbsentReason SHALL only be present if Observation.value[x] is not present", "key": "obs-6", "severity": "error", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))" }, { "expression": "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", "human": "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", "key": "obs-7", "severity": "error", "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]))" } ], "definition": "Measurements and simple assertions made about a patient, device or other subject.", "id": "Observation", "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]" } ], "max": "*", "min": 0, "path": "Observation", "short": "Measurements and simple assertions" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Observation.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.implicitRules", "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, "max": "1", "min": 0, "path": "Observation.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Observation.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Observation.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Observation.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Observation.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A unique identifier assigned to this observation.", "id": "Observation.identifier", "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" } ], "max": "0", "min": 0, "path": "Observation.identifier", "requirements": "Allows observations to be distinguished and referenced.", "short": "Business Identifier for observation", "type": [ { "code": "Identifier" } ] }, { "alias": [ "Fulfills" ], "base": { "max": "*", "min": 0, "path": "Observation.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.basedOn", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "ORC" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.basedOn", "requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", "short": "Fulfills plan, proposal or order", "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" ] } ] }, { "alias": [ "Container" ], "base": { "max": "*", "min": 0, "path": "Observation.partOf" }, "comment": "To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", "id": "Observation.partOf", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target" } ], "max": "0", "min": 0, "path": "Observation.partOf", "short": "Part of referenced event", "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" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.status" }, "binding": { "description": "Codes providing the status of an observation.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-status|4.0.1" }, "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Estado de la observación.\r\nValor por defecto: final", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final" } ], "id": "Observation.status", "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, "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\"" } ], "max": "1", "min": 1, "path": "Observation.status", "patternCode": "final", "requirements": "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", "short": "Estado de la observación.\r\nValor por defecto: final", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.category" }, "binding": { "description": "Codes for high level observation categories.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCategory" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the general type of observation being made.", "id": "Observation.category", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ], "max": "0", "min": 0, "path": "Observation.category", "requirements": "Used for filtering what observations are retrieved and displayed.", "short": "Classification of type of observation", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Name" ], "base": { "max": "1", "min": 1, "path": "Observation.code" }, "binding": { "description": "Codes identifying names of simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCode" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código que identifica la observación como el último periodo menstrual.", "id": "Observation.code", "isModifier": false, "isSummary": true, "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|" } ], "max": "1", "min": 1, "path": "Observation.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Código que identifica la observación como el último periodo menstrual.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Observation.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Sistema que define la codificación.\r\nValor por defecto: http://snomed.info/sct", "id": "Observation.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.code.coding.system", "patternUri": "http://snomed.info/sct", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Sistema que define la codificación.\r\nValor por defecto: http://snomed.info/sct", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código.\r\nValor por defecto: 21840007", "id": "Observation.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.code.coding.code", "patternCode": "21840007", "requirements": "Need to refer to a particular code in the system.", "short": "Código.\r\nValor por defecto: 21840007", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Descripción del código.\r\nValor por defecto: Último periodo menstrual", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.code.coding.display", "patternString": "Último periodo menstrual", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Descripción del código.\r\nValor por defecto: Último periodo menstrual", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.subject" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.subject", "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" } ], "max": "1", "min": 0, "path": "Observation.subject", "requirements": "Observations have no value if you don't know who or what they're about.", "short": "Who and/or what the observation is about", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "id": "Observation.focus", "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" } ], "max": "0", "min": 0, "path": "Observation.focus", "short": "What the observation is about, when it is not about the subject of record", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "alias": [ "Context" ], "base": { "max": "1", "min": 0, "path": "Observation.encounter" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", "id": "Observation.encounter", "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]" } ], "max": "1", "min": 0, "path": "Observation.encounter", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "short": "Healthcare event during which this observation is made", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "alias": [ "Occurrence" ], "base": { "max": "1", "min": 0, "path": "Observation.effective[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "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" } ], "max": "1", "min": 0, "path": "Observation.effective[x]", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.issued" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "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" } ], "max": "1", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "type": [ { "code": "instant" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.performer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who was responsible for asserting the observed value as \"true\".", "id": "Observation.performer", "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]" } ], "max": "1", "min": 1, "path": "Observation.performer", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "short": "Who is responsible for the observation", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH", "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.value[x]" }, "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.", "condition": [ "obs-7" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Example value '2023-12-20' [ES: Ejemplo del valor '2023-12-20']", "id": "Observation.value[x]", "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|" } ], "max": "1", "min": 1, "path": "Observation.value[x]", "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.", "short": "Example value '2023-12-20' [ES: Ejemplo del valor '2019-12-20']", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "id": "Observation.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "0", "min": 0, "path": "Observation.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "0", "min": 0, "path": "Observation.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.note" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Comments about the observation or the results.", "id": "Observation.note", "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" } ], "max": "*", "min": 0, "path": "Observation.note", "requirements": "Need to be able to provide free text additional information.", "short": "Comments about the observation", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.bodySite" }, "binding": { "description": "Codes describing anatomical locations. May include laterality.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the site on the subject's body where the observation was made (i.e. the target site).", "id": "Observation.bodySite", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 123037004 |Body structure|" }, { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": "targetSiteCode" }, { "identity": "sct-attr", "map": "718497002 |Inherent location|" } ], "max": "0", "min": 0, "path": "Observation.bodySite", "short": "Observed body part", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.method" }, "binding": { "description": "Methods for simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationMethod" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-methods" }, "comment": "Only used if not implicit in code for Observation.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the mechanism used to perform the observation.", "id": "Observation.method", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-17" }, { "identity": "rim", "map": "methodCode" } ], "max": "0", "min": 0, "path": "Observation.method", "requirements": "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", "short": "How it was done", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.specimen" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The specimen that was used when this observation was made.", "id": "Observation.specimen", "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|" } ], "max": "0", "min": 0, "path": "Observation.specimen", "short": "Specimen used for this observation", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.device" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The device used to generate the observation data.", "id": "Observation.device", "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|" } ], "max": "0", "min": 0, "path": "Observation.device", "short": "(Measurement) Device", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceMetric" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "low.exists() or high.exists() or text.exists()", "human": "Must have at least a low or a high or text", "key": "obs-3", "severity": "error", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))" } ], "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.", "id": "Observation.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.referenceRange", "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.", "short": "Provides guide for interpretation", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.referenceRange.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.referenceRange.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.referenceRange.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.low" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.low", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.low" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.high" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.high", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.high" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.type" }, "binding": { "description": "Code for the meaning of a reference range.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeMeaning" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-meaning" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", "id": "Observation.referenceRange.type", "isModifier": false, "isSummary": false, "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" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.type", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.", "short": "Reference range qualifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo" }, "binding": { "description": "Codes identifying the population the reference range applies to.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-appliesto" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.appliesTo", "isModifier": false, "isSummary": false, "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo", "requirements": "Need to be able to identify the target population for proper interpretation.", "short": "Reference range population", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.age" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.age", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.age", "requirements": "Some analytes vary greatly over age.", "short": "Applicable age range, if relevant", "type": [ { "code": "Range" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.text" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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\".", "id": "Observation.referenceRange.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:ST" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.hasMember" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.hasMember", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": "outBoundRelationship" } ], "max": "0", "min": 0, "path": "Observation.hasMember", "short": "Related resource that belongs to the Observation group", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", "http://hl7.org/fhir/StructureDefinition/MolecularSequence" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.derivedFrom" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.derivedFrom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": ".targetObservation" } ], "max": "0", "min": 0, "path": "Observation.derivedFrom", "short": "Related measurements the observation is made from", "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" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component" }, "comment": "For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.component", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "containment by OBX-4?" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=COMP]" } ], "max": "0", "min": 0, "path": "Observation.component", "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.", "short": "Component results", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.component.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.component.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.component.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.component.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.component.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.component.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.component.code" }, "binding": { "description": "Codes identifying names of simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCode" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "comment": "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "id": "Observation.component.code", "isModifier": false, "isSummary": true, "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" } ], "max": "1", "min": 1, "path": "Observation.component.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Type of component observation (code / type)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.value[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The information determined as a result of making the observation, if the information has a simple value.", "id": "Observation.component.value[x]", "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|" } ], "max": "1", "min": 0, "path": "Observation.component.value[x]", "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.", "short": "Actual component result", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", "id": "Observation.component.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the component result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.component.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.component.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "*", "min": 0, "path": "Observation.component.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Observation.referenceRange", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.", "id": "Observation.component.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "*", "min": 0, "path": "Observation.component.referenceRange", "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.", "short": "Provides guide for interpretation of component result" } ] }, "status": "draft", "title": "OneHealth ObsLastMenstrualPeriod", "type": "Observation", "url": "https://fhir.onehealth.com.pe/StructureDefinition/ObsLastMenstrualPeriodOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/ObsHoursOfSleepOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR ObsHoursOfSleepOH Profile, for OH interoperability scenarios, based on the national CORE Observation Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Observation.identifier", "max": "0", "path": "Observation.identifier" }, { "id": "Observation.basedOn", "max": "0", "path": "Observation.basedOn" }, { "id": "Observation.partOf", "max": "0", "path": "Observation.partOf" }, { "definition": "Estado de la observación.Valor por defecto: final", "id": "Observation.status", "path": "Observation.status", "patternCode": "final", "short": "Estado de la observación. Valor por defecto: final" }, { "id": "Observation.category", "max": "1", "min": 1, "path": "Observation.category" }, { "binding": { "strength": "required", "valueSet": "https://hl7.org/fhir/R4/valueset-observation-category.html" }, "id": "Observation.category.coding.system", "min": 1, "path": "Observation.category.coding.system" }, { "id": "Observation.category.coding.version", "max": "0", "path": "Observation.category.coding.version" }, { "fixedCode": "activity", "id": "Observation.category.coding.code", "min": 1, "path": "Observation.category.coding.code" }, { "id": "Observation.category.coding.display", "min": 1, "path": "Observation.category.coding.display" }, { "id": "Observation.category.coding.userSelected", "max": "0", "path": "Observation.category.coding.userSelected" }, { "id": "Observation.category.text", "max": "0", "path": "Observation.category.text" }, { "definition": "Código que identifica la observación como la cantidad de horas de sueño.", "id": "Observation.code", "path": "Observation.code", "short": "Código que identifica la observación como la cantidad de horas de sueño." }, { "id": "Observation.code.coding", "max": "1", "min": 1, "path": "Observation.code.coding" }, { "definition": "Sistema que define la codificación.Valor por defecto: http://loinc.org", "id": "Observation.code.coding.system", "min": 1, "path": "Observation.code.coding.system", "patternUri": "http://loinc.org", "short": "Sistema que define la codificación.Valor por defecto: http://loinc.org" }, { "id": "Observation.code.coding.version", "max": "0", "path": "Observation.code.coding.version" }, { "definition": "Código.Valor por defecto: 93832-4", "id": "Observation.code.coding.code", "min": 1, "path": "Observation.code.coding.code", "patternCode": "93832-4", "short": "Código.Valor por defecto: 93832-4" }, { "definition": "Descripción del código.Valor por defecto: cantidad de horas de sueño", "id": "Observation.code.coding.display", "min": 1, "path": "Observation.code.coding.display", "patternString": "Duración del sueño", "short": "Descripción del código. Valor por defecto: cantidad de horas de sueño" }, { "id": "Observation.code.coding.userSelected", "max": "0", "path": "Observation.code.coding.userSelected" }, { "id": "Observation.code.text", "max": "0", "path": "Observation.code.text" }, { "id": "Observation.subject", "min": 1, "path": "Observation.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Observation.focus", "max": "0", "path": "Observation.focus" }, { "id": "Observation.encounter", "path": "Observation.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "min": 1, "path": "Observation.effective[x]", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]" }, { "id": "Observation.performer", "max": "1", "min": 1, "path": "Observation.performer", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "Observation.value[x]", "min": 1, "path": "Observation.value[x]", "type": [ { "code": "Quantity" } ] }, { "definition": "Example value '7' [ES: Ejemplo de valor '7']", "id": "Observation.value[x].value", "path": "Observation.value[x].value", "short": "Example value '7' [ES: Ejemplo de valor '7']" }, { "id": "Observation.value[x].comparator", "max": "0", "path": "Observation.value[x].comparator" }, { "fixedString": "h", "id": "Observation.value[x].unit", "min": 1, "path": "Observation.value[x].unit" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/duration-units" }, "id": "Observation.value[x].system", "min": 1, "path": "Observation.value[x].system" }, { "id": "Observation.value[x].code", "min": 1, "path": "Observation.value[x].code" }, { "id": "Observation.dataAbsentReason", "max": "0", "path": "Observation.dataAbsentReason" }, { "id": "Observation.interpretation", "max": "0", "path": "Observation.interpretation" }, { "id": "Observation.bodySite", "max": "0", "path": "Observation.bodySite" }, { "id": "Observation.method", "max": "0", "path": "Observation.method" }, { "id": "Observation.specimen", "max": "0", "path": "Observation.specimen" }, { "id": "Observation.device", "max": "0", "path": "Observation.device" }, { "id": "Observation.referenceRange", "max": "0", "path": "Observation.referenceRange" }, { "id": "Observation.hasMember", "max": "0", "path": "Observation.hasMember" }, { "id": "Observation.derivedFrom", "max": "0", "path": "Observation.derivedFrom" }, { "id": "Observation.component", "max": "0", "path": "Observation.component" } ] }, "fhirVersion": "4.0.1", "id": "ObsHoursOfSleepOH", "jurisdiction": [ { "coding": [ { "code": "PER", "display": "Perú", "system": "urn:iso:std:iso:3166" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "sct-concept", "name": "SNOMED CT Concept Domain Binding", "uri": "http://snomed.info/conceptdomain" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "sct-attr", "name": "SNOMED CT Attribute Binding", "uri": "http://snomed.org/attributebinding" } ], "meta": { "lastUpdated": "2024-04-12T17:46:24.829152+00:00", "versionId": "MTcxMjk0Mzk4NDgyOTE1MjAwMA" }, "name": "ObsHoursOfSleepOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Vital Signs", "Measurement", "Results", "Tests" ], "base": { "max": "*", "min": 0, "path": "Observation" }, "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.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "dataAbsentReason.empty() or value.empty()", "human": "dataAbsentReason SHALL only be present if Observation.value[x] is not present", "key": "obs-6", "severity": "error", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))" }, { "expression": "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", "human": "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", "key": "obs-7", "severity": "error", "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]))" } ], "definition": "Measurements and simple assertions made about a patient, device or other subject.", "id": "Observation", "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]" } ], "max": "*", "min": 0, "path": "Observation", "short": "Measurements and simple assertions" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Observation.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.implicitRules", "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, "max": "1", "min": 0, "path": "Observation.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Observation.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Observation.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Observation.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Observation.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A unique identifier assigned to this observation.", "id": "Observation.identifier", "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" } ], "max": "0", "min": 0, "path": "Observation.identifier", "requirements": "Allows observations to be distinguished and referenced.", "short": "Business Identifier for observation", "type": [ { "code": "Identifier" } ] }, { "alias": [ "Fulfills" ], "base": { "max": "*", "min": 0, "path": "Observation.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.basedOn", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "ORC" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.basedOn", "requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", "short": "Fulfills plan, proposal or order", "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" ] } ] }, { "alias": [ "Container" ], "base": { "max": "*", "min": 0, "path": "Observation.partOf" }, "comment": "To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", "id": "Observation.partOf", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target" } ], "max": "0", "min": 0, "path": "Observation.partOf", "short": "Part of referenced event", "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" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.status" }, "binding": { "description": "Codes providing the status of an observation.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-status|4.0.1" }, "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Estado de la observación.Valor por defecto: final", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final" } ], "id": "Observation.status", "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, "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\"" } ], "max": "1", "min": 1, "path": "Observation.status", "patternCode": "final", "requirements": "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", "short": "Estado de la observación. Valor por defecto: final", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.category" }, "binding": { "description": "Codes for high level observation categories.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCategory" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the general type of observation being made.", "id": "Observation.category", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ], "max": "1", "min": 1, "path": "Observation.category", "requirements": "Used for filtering what observations are retrieved and displayed.", "short": "Classification of type of observation", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.category.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Observation.category.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "binding": { "strength": "required", "valueSet": "https://hl7.org/fhir/R4/valueset-observation-category.html" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Observation.category.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.category.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.category.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.category.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "fixedCode": "activity", "id": "Observation.category.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.category.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.category.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.category.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.category.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.category.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "Name" ], "base": { "max": "1", "min": 1, "path": "Observation.code" }, "binding": { "description": "Codes identifying names of simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCode" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código que identifica la observación como la cantidad de horas de sueño.", "id": "Observation.code", "isModifier": false, "isSummary": true, "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|" } ], "max": "1", "min": 1, "path": "Observation.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Código que identifica la observación como la cantidad de horas de sueño.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Observation.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Sistema que define la codificación.Valor por defecto: http://loinc.org", "id": "Observation.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.code.coding.system", "patternUri": "http://loinc.org", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Sistema que define la codificación.Valor por defecto: http://loinc.org", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código.Valor por defecto: 93832-4", "id": "Observation.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.code.coding.code", "patternCode": "93832-4", "requirements": "Need to refer to a particular code in the system.", "short": "Código.Valor por defecto: 93832-4", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Descripción del código.Valor por defecto: cantidad de horas de sueño", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.code.coding.display", "patternString": "Duración del sueño", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Descripción del código. Valor por defecto: cantidad de horas de sueño", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.subject" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.subject", "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" } ], "max": "1", "min": 1, "path": "Observation.subject", "requirements": "Observations have no value if you don't know who or what they're about.", "short": "Who and/or what the observation is about", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "id": "Observation.focus", "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" } ], "max": "0", "min": 0, "path": "Observation.focus", "short": "What the observation is about, when it is not about the subject of record", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "alias": [ "Context" ], "base": { "max": "1", "min": 0, "path": "Observation.encounter" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", "id": "Observation.encounter", "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]" } ], "max": "1", "min": 0, "path": "Observation.encounter", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "short": "Healthcare event during which this observation is made", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "alias": [ "Occurrence" ], "base": { "max": "1", "min": 0, "path": "Observation.effective[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "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" } ], "max": "1", "min": 1, "path": "Observation.effective[x]", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.issued" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "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" } ], "max": "1", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "type": [ { "code": "instant" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.performer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who was responsible for asserting the observed value as \"true\".", "id": "Observation.performer", "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]" } ], "max": "1", "min": 1, "path": "Observation.performer", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "short": "Who is responsible for the observation", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.value[x]" }, "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.", "condition": [ "obs-7" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The information determined as a result of making the observation, if the information has a simple value.", "id": "Observation.value[x]", "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|" } ], "max": "1", "min": 1, "path": "Observation.value[x]", "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.", "short": "Actual result", "type": [ { "code": "Quantity" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.value[x].id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.value[x].id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.value[x].extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.value[x].extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.value" }, "comment": "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Example value '7' [ES: Ejemplo de valor '7']", "id": "Observation.value[x].value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "SN.2 / CQ - N/A" }, { "identity": "rim", "map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value" } ], "max": "1", "min": 0, "path": "Observation.value[x].value", "requirements": "Precision is handled implicitly in almost all cases of measurement.", "short": "Example value '7' [ES: Ejemplo de valor '7']", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.comparator" }, "binding": { "description": "How the Quantity should be understood and represented.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuantityComparator" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.", "id": "Observation.value[x].comparator", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value", "isSummary": true, "mapping": [ { "identity": "v2", "map": "SN.1 / CQ.1" }, { "identity": "rim", "map": "IVL properties" } ], "max": "0", "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "min": 0, "path": "Observation.value[x].comparator", "requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.", "short": "< | <= | >= | > - how to understand the value", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.unit" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable form of the unit.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "fixedString": "h", "id": "Observation.value[x].unit", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ], "max": "1", "min": 1, "path": "Observation.value[x].unit", "requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.", "short": "Unit representation", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.system" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/duration-units" }, "condition": [ "qty-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the system that provides the coded form of the unit.", "id": "Observation.value[x].system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "CO.codeSystem, PQ.translation.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.value[x].system", "requirements": "Need to know the system that defines the coded form of the unit.", "short": "System that defines coded unit form", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.code" }, "comment": "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A computer processable form of the unit in some unit representation system.", "id": "Observation.value[x].code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.code, MO.currency, PQ.translation.code" } ], "max": "1", "min": 1, "path": "Observation.value[x].code", "requirements": "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.", "short": "Coded form of the unit", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "id": "Observation.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "0", "min": 0, "path": "Observation.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "0", "min": 0, "path": "Observation.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.note" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Comments about the observation or the results.", "id": "Observation.note", "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" } ], "max": "*", "min": 0, "path": "Observation.note", "requirements": "Need to be able to provide free text additional information.", "short": "Comments about the observation", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.bodySite" }, "binding": { "description": "Codes describing anatomical locations. May include laterality.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the site on the subject's body where the observation was made (i.e. the target site).", "id": "Observation.bodySite", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 123037004 |Body structure|" }, { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": "targetSiteCode" }, { "identity": "sct-attr", "map": "718497002 |Inherent location|" } ], "max": "0", "min": 0, "path": "Observation.bodySite", "short": "Observed body part", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.method" }, "binding": { "description": "Methods for simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationMethod" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-methods" }, "comment": "Only used if not implicit in code for Observation.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the mechanism used to perform the observation.", "id": "Observation.method", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-17" }, { "identity": "rim", "map": "methodCode" } ], "max": "0", "min": 0, "path": "Observation.method", "requirements": "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", "short": "How it was done", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.specimen" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The specimen that was used when this observation was made.", "id": "Observation.specimen", "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|" } ], "max": "0", "min": 0, "path": "Observation.specimen", "short": "Specimen used for this observation", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.device" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The device used to generate the observation data.", "id": "Observation.device", "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|" } ], "max": "0", "min": 0, "path": "Observation.device", "short": "(Measurement) Device", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceMetric" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "low.exists() or high.exists() or text.exists()", "human": "Must have at least a low or a high or text", "key": "obs-3", "severity": "error", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))" } ], "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.", "id": "Observation.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.referenceRange", "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.", "short": "Provides guide for interpretation", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.referenceRange.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.referenceRange.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.referenceRange.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.low" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.low", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.low" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.high" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.high", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.high" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.type" }, "binding": { "description": "Code for the meaning of a reference range.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeMeaning" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-meaning" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", "id": "Observation.referenceRange.type", "isModifier": false, "isSummary": false, "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" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.type", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.", "short": "Reference range qualifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo" }, "binding": { "description": "Codes identifying the population the reference range applies to.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-appliesto" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.appliesTo", "isModifier": false, "isSummary": false, "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo", "requirements": "Need to be able to identify the target population for proper interpretation.", "short": "Reference range population", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.age" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.age", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.age", "requirements": "Some analytes vary greatly over age.", "short": "Applicable age range, if relevant", "type": [ { "code": "Range" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.text" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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\".", "id": "Observation.referenceRange.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:ST" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.hasMember" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.hasMember", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": "outBoundRelationship" } ], "max": "0", "min": 0, "path": "Observation.hasMember", "short": "Related resource that belongs to the Observation group", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", "http://hl7.org/fhir/StructureDefinition/MolecularSequence" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.derivedFrom" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.derivedFrom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": ".targetObservation" } ], "max": "0", "min": 0, "path": "Observation.derivedFrom", "short": "Related measurements the observation is made from", "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" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component" }, "comment": "For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.component", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "containment by OBX-4?" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=COMP]" } ], "max": "0", "min": 0, "path": "Observation.component", "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.", "short": "Component results", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.component.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.component.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.component.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.component.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.component.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.component.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.component.code" }, "binding": { "description": "Codes identifying names of simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCode" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "comment": "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "id": "Observation.component.code", "isModifier": false, "isSummary": true, "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" } ], "max": "1", "min": 1, "path": "Observation.component.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Type of component observation (code / type)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.value[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The information determined as a result of making the observation, if the information has a simple value.", "id": "Observation.component.value[x]", "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|" } ], "max": "1", "min": 0, "path": "Observation.component.value[x]", "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.", "short": "Actual component result", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", "id": "Observation.component.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the component result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.component.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.component.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "*", "min": 0, "path": "Observation.component.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Observation.referenceRange", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.", "id": "Observation.component.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "*", "min": 0, "path": "Observation.component.referenceRange", "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.", "short": "Provides guide for interpretation of component result" } ] }, "status": "draft", "title": "OneHealth ObsHoursOfSleep", "type": "Observation", "url": "https://fhir.onehealth.com.pe/StructureDefinition/ObsHoursOfSleepOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/ObsEDCOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-15", "derivation": "constraint", "description": "FHIR ObsEDCOH (Estimated Date of Confinement) Profile, for OH interoperability scenarios, based on the national CORE Observation Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Observation.identifier", "max": "0", "path": "Observation.identifier" }, { "id": "Observation.basedOn", "max": "0", "path": "Observation.basedOn" }, { "id": "Observation.partOf", "max": "0", "path": "Observation.partOf" }, { "definition": "Estado de la observación.\r\nValor por defecto: final", "id": "Observation.status", "path": "Observation.status", "patternCode": "final", "short": "Estado de la observación.\r\nValor por defecto: final" }, { "id": "Observation.category", "max": "0", "path": "Observation.category" }, { "definition": "Código que identifica la observación como la fecha probable de parto.", "id": "Observation.code", "path": "Observation.code", "short": "Código que identifica la observación como la fecha probable de parto." }, { "id": "Observation.code.coding", "max": "1", "min": 1, "path": "Observation.code.coding" }, { "definition": "Sistema que define la codificación.\r\nValor por defecto: http://snomed.info/sct", "id": "Observation.code.coding.system", "min": 1, "path": "Observation.code.coding.system", "patternUri": "http://snomed.info/sct", "short": "Sistema que define la codificación.\r\nValor por defecto: http://snomed.info/sct" }, { "id": "Observation.code.coding.version", "max": "0", "path": "Observation.code.coding.version" }, { "definition": "Código.\r\nValor por defecto: 161714006", "id": "Observation.code.coding.code", "min": 1, "path": "Observation.code.coding.code", "patternCode": "161714006", "short": "Código.\r\nValor por defecto: 161714006" }, { "definition": "Descripción del código.\r\nValor por defecto: Fecha probable de parto", "id": "Observation.code.coding.display", "min": 1, "path": "Observation.code.coding.display", "patternString": "Fecha probable de parto", "short": "Descripción del código.\r\nValor por defecto: Fecha probable de parto" }, { "id": "Observation.code.coding.userSelected", "max": "0", "path": "Observation.code.coding.userSelected" }, { "id": "Observation.code.text", "max": "0", "path": "Observation.code.text" }, { "id": "Observation.subject", "path": "Observation.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Observation.focus", "max": "0", "path": "Observation.focus" }, { "id": "Observation.encounter", "path": "Observation.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "path": "Observation.effective[x]", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]" }, { "id": "Observation.performer", "path": "Observation.performer", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "definition": "Example value '2019-12-20' [ES: Ejemplo del valor '2019-12-20']", "id": "Observation.value[x]", "min": 1, "path": "Observation.value[x]", "short": "Example value '2019-12-20' [ES: Ejemplo del valor '2019-12-20']", "type": [ { "code": "dateTime" } ] }, { "id": "Observation.dataAbsentReason", "max": "0", "path": "Observation.dataAbsentReason" }, { "id": "Observation.interpretation", "max": "0", "path": "Observation.interpretation" }, { "id": "Observation.bodySite", "max": "0", "path": "Observation.bodySite" }, { "id": "Observation.method", "max": "0", "path": "Observation.method" }, { "id": "Observation.specimen", "max": "0", "path": "Observation.specimen" }, { "id": "Observation.device", "max": "0", "path": "Observation.device" }, { "id": "Observation.referenceRange", "max": "0", "path": "Observation.referenceRange" }, { "id": "Observation.hasMember", "max": "0", "path": "Observation.hasMember" }, { "id": "Observation.derivedFrom", "max": "0", "path": "Observation.derivedFrom" }, { "id": "Observation.component", "max": "0", "path": "Observation.component" } ] }, "fhirVersion": "4.0.1", "id": "ObsEDCOH", "jurisdiction": [ { "coding": [ { "code": "PER", "display": "Perú", "system": "urn:iso:std:iso:3166" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "sct-concept", "name": "SNOMED CT Concept Domain Binding", "uri": "http://snomed.info/conceptdomain" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "sct-attr", "name": "SNOMED CT Attribute Binding", "uri": "http://snomed.org/attributebinding" } ], "meta": { "lastUpdated": "2024-04-12T17:46:24.563833+00:00", "versionId": "MTcxMjk0Mzk4NDU2MzgzMzAwMA" }, "name": "ObsEDCOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Vital Signs", "Measurement", "Results", "Tests" ], "base": { "max": "*", "min": 0, "path": "Observation" }, "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.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "dataAbsentReason.empty() or value.empty()", "human": "dataAbsentReason SHALL only be present if Observation.value[x] is not present", "key": "obs-6", "severity": "error", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))" }, { "expression": "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", "human": "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", "key": "obs-7", "severity": "error", "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]))" } ], "definition": "Measurements and simple assertions made about a patient, device or other subject.", "id": "Observation", "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]" } ], "max": "*", "min": 0, "path": "Observation", "short": "Measurements and simple assertions" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Observation.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.implicitRules", "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, "max": "1", "min": 0, "path": "Observation.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Observation.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Observation.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Observation.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Observation.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A unique identifier assigned to this observation.", "id": "Observation.identifier", "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" } ], "max": "0", "min": 0, "path": "Observation.identifier", "requirements": "Allows observations to be distinguished and referenced.", "short": "Business Identifier for observation", "type": [ { "code": "Identifier" } ] }, { "alias": [ "Fulfills" ], "base": { "max": "*", "min": 0, "path": "Observation.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.basedOn", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "ORC" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.basedOn", "requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", "short": "Fulfills plan, proposal or order", "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" ] } ] }, { "alias": [ "Container" ], "base": { "max": "*", "min": 0, "path": "Observation.partOf" }, "comment": "To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", "id": "Observation.partOf", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target" } ], "max": "0", "min": 0, "path": "Observation.partOf", "short": "Part of referenced event", "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" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.status" }, "binding": { "description": "Codes providing the status of an observation.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-status|4.0.1" }, "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Estado de la observación.\r\nValor por defecto: final", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final" } ], "id": "Observation.status", "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, "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\"" } ], "max": "1", "min": 1, "path": "Observation.status", "patternCode": "final", "requirements": "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", "short": "Estado de la observación.\r\nValor por defecto: final", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.category" }, "binding": { "description": "Codes for high level observation categories.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCategory" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the general type of observation being made.", "id": "Observation.category", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ], "max": "0", "min": 0, "path": "Observation.category", "requirements": "Used for filtering what observations are retrieved and displayed.", "short": "Classification of type of observation", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Name" ], "base": { "max": "1", "min": 1, "path": "Observation.code" }, "binding": { "description": "Codes identifying names of simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCode" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código que identifica la observación como la fecha probable de parto.", "id": "Observation.code", "isModifier": false, "isSummary": true, "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|" } ], "max": "1", "min": 1, "path": "Observation.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Código que identifica la observación como la fecha probable de parto.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Observation.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Sistema que define la codificación.\r\nValor por defecto: http://snomed.info/sct", "id": "Observation.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.code.coding.system", "patternUri": "http://snomed.info/sct", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Sistema que define la codificación.\r\nValor por defecto: http://snomed.info/sct", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código.\r\nValor por defecto: 161714006", "id": "Observation.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.code.coding.code", "patternCode": "161714006", "requirements": "Need to refer to a particular code in the system.", "short": "Código.\r\nValor por defecto: 161714006", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Descripción del código.\r\nValor por defecto: Fecha probable de parto", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.code.coding.display", "patternString": "Fecha probable de parto", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Descripción del código.\r\nValor por defecto: Fecha probable de parto", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.subject" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.subject", "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" } ], "max": "1", "min": 0, "path": "Observation.subject", "requirements": "Observations have no value if you don't know who or what they're about.", "short": "Who and/or what the observation is about", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "id": "Observation.focus", "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" } ], "max": "0", "min": 0, "path": "Observation.focus", "short": "What the observation is about, when it is not about the subject of record", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "alias": [ "Context" ], "base": { "max": "1", "min": 0, "path": "Observation.encounter" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", "id": "Observation.encounter", "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]" } ], "max": "1", "min": 0, "path": "Observation.encounter", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "short": "Healthcare event during which this observation is made", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "alias": [ "Occurrence" ], "base": { "max": "1", "min": 0, "path": "Observation.effective[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "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" } ], "max": "1", "min": 0, "path": "Observation.effective[x]", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.issued" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "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" } ], "max": "1", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "type": [ { "code": "instant" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.performer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who was responsible for asserting the observed value as \"true\".", "id": "Observation.performer", "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]" } ], "max": "*", "min": 0, "path": "Observation.performer", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "short": "Who is responsible for the observation", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.value[x]" }, "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.", "condition": [ "obs-7" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Example value '2019-12-20' [ES: Ejemplo del valor '2019-12-20']", "id": "Observation.value[x]", "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|" } ], "max": "1", "min": 1, "path": "Observation.value[x]", "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.", "short": "Example value '2019-12-20' [ES: Ejemplo del valor '2019-12-20']", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "id": "Observation.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "0", "min": 0, "path": "Observation.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "0", "min": 0, "path": "Observation.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.note" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Comments about the observation or the results.", "id": "Observation.note", "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" } ], "max": "*", "min": 0, "path": "Observation.note", "requirements": "Need to be able to provide free text additional information.", "short": "Comments about the observation", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.bodySite" }, "binding": { "description": "Codes describing anatomical locations. May include laterality.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the site on the subject's body where the observation was made (i.e. the target site).", "id": "Observation.bodySite", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 123037004 |Body structure|" }, { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": "targetSiteCode" }, { "identity": "sct-attr", "map": "718497002 |Inherent location|" } ], "max": "0", "min": 0, "path": "Observation.bodySite", "short": "Observed body part", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.method" }, "binding": { "description": "Methods for simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationMethod" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-methods" }, "comment": "Only used if not implicit in code for Observation.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the mechanism used to perform the observation.", "id": "Observation.method", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-17" }, { "identity": "rim", "map": "methodCode" } ], "max": "0", "min": 0, "path": "Observation.method", "requirements": "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", "short": "How it was done", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.specimen" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The specimen that was used when this observation was made.", "id": "Observation.specimen", "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|" } ], "max": "0", "min": 0, "path": "Observation.specimen", "short": "Specimen used for this observation", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.device" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The device used to generate the observation data.", "id": "Observation.device", "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|" } ], "max": "0", "min": 0, "path": "Observation.device", "short": "(Measurement) Device", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceMetric" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "low.exists() or high.exists() or text.exists()", "human": "Must have at least a low or a high or text", "key": "obs-3", "severity": "error", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))" } ], "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.", "id": "Observation.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.referenceRange", "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.", "short": "Provides guide for interpretation", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.referenceRange.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.referenceRange.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.referenceRange.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.low" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.low", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.low" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.high" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.high", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.high" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.type" }, "binding": { "description": "Code for the meaning of a reference range.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeMeaning" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-meaning" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", "id": "Observation.referenceRange.type", "isModifier": false, "isSummary": false, "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" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.type", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.", "short": "Reference range qualifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo" }, "binding": { "description": "Codes identifying the population the reference range applies to.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-appliesto" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.appliesTo", "isModifier": false, "isSummary": false, "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo", "requirements": "Need to be able to identify the target population for proper interpretation.", "short": "Reference range population", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.age" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.age", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.age", "requirements": "Some analytes vary greatly over age.", "short": "Applicable age range, if relevant", "type": [ { "code": "Range" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.text" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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\".", "id": "Observation.referenceRange.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:ST" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.hasMember" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.hasMember", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": "outBoundRelationship" } ], "max": "0", "min": 0, "path": "Observation.hasMember", "short": "Related resource that belongs to the Observation group", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", "http://hl7.org/fhir/StructureDefinition/MolecularSequence" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.derivedFrom" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.derivedFrom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": ".targetObservation" } ], "max": "0", "min": 0, "path": "Observation.derivedFrom", "short": "Related measurements the observation is made from", "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" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component" }, "comment": "For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.component", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "containment by OBX-4?" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=COMP]" } ], "max": "0", "min": 0, "path": "Observation.component", "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.", "short": "Component results", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.component.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.component.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.component.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.component.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.component.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.component.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.component.code" }, "binding": { "description": "Codes identifying names of simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCode" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "comment": "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "id": "Observation.component.code", "isModifier": false, "isSummary": true, "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" } ], "max": "1", "min": 1, "path": "Observation.component.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Type of component observation (code / type)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.value[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The information determined as a result of making the observation, if the information has a simple value.", "id": "Observation.component.value[x]", "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|" } ], "max": "1", "min": 0, "path": "Observation.component.value[x]", "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.", "short": "Actual component result", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", "id": "Observation.component.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the component result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.component.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.component.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "*", "min": 0, "path": "Observation.component.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Observation.referenceRange", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.", "id": "Observation.component.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "*", "min": 0, "path": "Observation.component.referenceRange", "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.", "short": "Provides guide for interpretation of component result" } ] }, "status": "draft", "title": "OneHealth ObsEDC", "type": "Observation", "url": "https://fhir.onehealth.com.pe/StructureDefinition/ObsEDCOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/ObsBodyWeightOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/vitalsigns", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR ObsBodyWeightOH Profile, for OH interoperability scenarios, based on the national CORE Observationvitalsigns Profile defined by HL7 OH.", "differential": { "element": [ { "definition": "This profile defines how to represent body weight observations in FHIR using a standard LOINC code and UCUM units of measure.", "id": "Observation", "path": "Observation", "short": "FHIR Body Weight Profile" }, { "id": "Observation.identifier", "max": "0", "path": "Observation.identifier" }, { "id": "Observation.basedOn", "max": "0", "path": "Observation.basedOn" }, { "id": "Observation.partOf", "max": "0", "path": "Observation.partOf" }, { "id": "Observation.category:VSCat", "path": "Observation.category", "sliceName": "VSCat" }, { "id": "Observation.category:VSCat.coding.version", "max": "0", "path": "Observation.category.coding.version" }, { "id": "Observation.category:VSCat.coding.userSelected", "max": "0", "path": "Observation.category.coding.userSelected" }, { "id": "Observation.code.coding", "min": 1, "path": "Observation.code.coding", "slicing": { "discriminator": [ { "path": "code", "type": "value" }, { "path": "system", "type": "value" } ], "ordered": false, "rules": "open" } }, { "id": "Observation.code.coding:BodyWeightCode", "max": "1", "min": 1, "path": "Observation.code.coding", "sliceName": "BodyWeightCode" }, { "fixedUri": "http://loinc.org", "id": "Observation.code.coding:BodyWeightCode.system", "min": 1, "path": "Observation.code.coding.system" }, { "fixedCode": "29463-7", "id": "Observation.code.coding:BodyWeightCode.code", "min": 1, "path": "Observation.code.coding.code" }, { "id": "Observation.subject", "path": "Observation.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Observation.focus", "max": "0", "path": "Observation.focus" }, { "id": "Observation.encounter", "path": "Observation.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "path": "Observation.effective[x]", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]" }, { "id": "Observation.performer", "path": "Observation.performer", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH", "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Observation.value[x]", "min": 1, "path": "Observation.value[x]", "slicing": { "discriminator": [ { "path": "$this", "type": "type" } ], "ordered": false, "rules": "open" } }, { "id": "Observation.value[x]:valueQuantity", "max": "1", "min": 1, "path": "Observation.value[x]", "sliceName": "valueQuantity", "type": [ { "code": "Quantity" } ] }, { "id": "Observation.value[x]:valueQuantity.value", "min": 1, "mustSupport": true, "path": "Observation.value[x].value" }, { "id": "Observation.value[x]:valueQuantity.unit", "min": 1, "mustSupport": true, "path": "Observation.value[x].unit" }, { "fixedUri": "http://unitsofmeasure.org", "id": "Observation.value[x]:valueQuantity.system", "min": 1, "mustSupport": true, "path": "Observation.value[x].system" }, { "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "Common UCUM units for Body Weight." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodyWeightUnits" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-bodyweight" }, "definition": "Coded responses from the common UCUM units for vital signs value set.", "fixedCode": "Kg", "id": "Observation.value[x]:valueQuantity.code", "min": 1, "mustSupport": true, "path": "Observation.value[x].code", "short": "Coded responses from the common UCUM units for vital signs value set." }, { "id": "Observation.dataAbsentReason", "max": "0", "path": "Observation.dataAbsentReason" }, { "id": "Observation.interpretation", "max": "1", "path": "Observation.interpretation" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "id": "Observation.interpretation.coding.system", "min": 1, "path": "Observation.interpretation.coding.system" }, { "id": "Observation.interpretation.coding.version", "max": "0", "path": "Observation.interpretation.coding.version" }, { "id": "Observation.interpretation.coding.code", "min": 1, "path": "Observation.interpretation.coding.code" }, { "id": "Observation.interpretation.coding.display", "min": 1, "path": "Observation.interpretation.coding.display" }, { "id": "Observation.interpretation.coding.userSelected", "max": "0", "path": "Observation.interpretation.coding.userSelected" }, { "id": "Observation.interpretation.text", "max": "0", "path": "Observation.interpretation.text" }, { "id": "Observation.bodySite", "max": "0", "path": "Observation.bodySite" }, { "id": "Observation.method", "max": "0", "path": "Observation.method" }, { "id": "Observation.specimen", "max": "0", "path": "Observation.specimen" }, { "id": "Observation.device", "max": "0", "path": "Observation.device" }, { "id": "Observation.referenceRange", "max": "0", "path": "Observation.referenceRange" }, { "id": "Observation.hasMember", "max": "0", "path": "Observation.hasMember" }, { "id": "Observation.derivedFrom", "max": "0", "path": "Observation.derivedFrom" }, { "id": "Observation.component", "max": "0", "path": "Observation.component" } ] }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-summary", "valueMarkdown": "#### Complete Summary of the Mandatory Requirements\r\r1. One code in `Observation.code` which must have\r - a fixed `Observation.code.coding.system`=**'http ://loinc.org'**\r - a fixed `Observation.code.coding.code`= **'29463-7'**\r - Other additional Codings are allowed in `Observation.code`- e.g. more specific LOINC\r Codes, SNOMED CT concepts, system specific codes. All codes\r SHALL have an system value\r1. Either one Observation.valueQuantity or, if there is no value, one code in Observation.DataAbsentReason\r - Each Observation.valueQuantity must have:\r - One numeric value in Observation.valueQuantity.value\r - a fixed Observation.valueQuantity.system=\"http://unitsofmeasure.org\"\r - a UCUM unit code in Observation.valueQuantity.code = **'kg', 'g', or '[lb_av]'**" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 5 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "oo" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "fhirVersion": "4.0.1", "id": "ObsBodyWeightOH", "jurisdiction": [ { "coding": [ { "code": "PER", "display": "Perú", "system": "urn:iso:std:iso:3166" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "sct-concept", "name": "SNOMED CT Concept Domain Binding", "uri": "http://snomed.info/conceptdomain" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "sct-attr", "name": "SNOMED CT Attribute Binding", "uri": "http://snomed.org/attributebinding" } ], "meta": { "lastUpdated": "2024-04-12T17:46:24.333882+00:00", "versionId": "MTcxMjk0Mzk4NDMzMzg4MjAwMA" }, "name": "ObsBodyWeightOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Vital Signs", "Measurement", "Results", "Tests" ], "base": { "max": "*", "min": 0, "path": "Observation" }, "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.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "dataAbsentReason.empty() or value.empty()", "human": "dataAbsentReason SHALL only be present if Observation.value[x] is not present", "key": "obs-6", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Observation", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))" }, { "expression": "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", "human": "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", "key": "obs-7", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Observation", "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]))" }, { "expression": "(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())", "human": "If there is no component or hasMember element then either a value[x] or a data absent reason must be present.", "key": "vs-2", "severity": "error", "xpath": "f:component or f:memberOF or f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason" } ], "definition": "This profile defines how to represent body weight observations in FHIR using a standard LOINC code and UCUM units of measure.", "id": "Observation", "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]" } ], "max": "*", "min": 0, "path": "Observation", "short": "FHIR Body Weight Profile" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Observation.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.implicitRules", "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, "max": "1", "min": 0, "path": "Observation.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Observation.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Observation.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Observation.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Observation.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A unique identifier assigned to this observation.", "id": "Observation.identifier", "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" } ], "max": "0", "min": 0, "path": "Observation.identifier", "requirements": "Allows observations to be distinguished and referenced.", "short": "Business Identifier for observation", "type": [ { "code": "Identifier" } ] }, { "alias": [ "Fulfills" ], "base": { "max": "*", "min": 0, "path": "Observation.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.basedOn", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "ORC" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.basedOn", "requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", "short": "Fulfills plan, proposal or order", "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" ] } ] }, { "alias": [ "Container" ], "base": { "max": "*", "min": 0, "path": "Observation.partOf" }, "comment": "To link an Observation to an Encounter use `encounter`. See the [Notes](http://hl7.org/fhir/observation.html#obsgrouping) below for guidance on referencing another Observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", "id": "Observation.partOf", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target" } ], "max": "0", "min": 0, "path": "Observation.partOf", "short": "Part of referenced event", "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" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.status" }, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Status" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-status|4.0.1" }, "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status of the result value.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final" } ], "id": "Observation.status", "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, "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\"" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.status", "requirements": "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", "short": "registered | preliminary | final | amended +", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.category" }, "binding": { "description": "Codes for high level observation categories.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCategory" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the general type of observation being made.", "id": "Observation.category", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ], "max": "*", "min": 1, "mustSupport": true, "path": "Observation.category", "requirements": "Used for filtering what observations are retrieved and displayed.", "short": "Classification of type of observation", "slicing": { "discriminator": [ { "path": "coding.code", "type": "value" }, { "path": "coding.system", "type": "value" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.category" }, "binding": { "description": "Codes for high level observation categories.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCategory" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the general type of observation being made.", "id": "Observation.category:VSCat", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.category", "requirements": "Used for filtering what observations are retrieved and displayed.", "short": "Classification of type of observation", "sliceName": "VSCat", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category:VSCat.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category:VSCat.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.category:VSCat.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 1, "mustSupport": true, "path": "Observation.category.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category:VSCat.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category:VSCat.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "fixedUri": "http://terminology.hl7.org/CodeSystem/observation-category", "id": "Observation.category:VSCat.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.category.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.category:VSCat.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.category.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "fixedCode": "vital-signs", "id": "Observation.category:VSCat.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.category.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category:VSCat.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 0, "path": "Observation.category.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.category:VSCat.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.category.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category:VSCat.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "Observation.category.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "Name" ], "base": { "max": "1", "min": 1, "path": "Observation.code" }, "binding": { "description": "This identifies the vital sign result type.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VitalSigns" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-vitalsignresult" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Coded Responses from C-CDA Vital Sign Results.", "id": "Observation.code", "isModifier": false, "isSummary": true, "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|" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.code", "requirements": "5. SHALL contain exactly one [1..1] code, where the @code SHOULD be selected from ValueSet HITSP Vital Sign Result Type 2.16.840.1.113883.3.88.12.80.62 DYNAMIC (CONF:7301).", "short": "Coded Responses from C-CDA Vital Sign Results", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 1, "path": "Observation.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "slicing": { "discriminator": [ { "path": "code", "type": "value" }, { "path": "system", "type": "value" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "Coding" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.code.coding:BodyWeightCode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Observation.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "sliceName": "BodyWeightCode", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.coding:BodyWeightCode.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.coding:BodyWeightCode.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "fixedUri": "http://loinc.org", "id": "Observation.code.coding:BodyWeightCode.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.code.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.code.coding:BodyWeightCode.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "1", "min": 0, "path": "Observation.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "fixedCode": "29463-7", "id": "Observation.code.coding:BodyWeightCode.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.code.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.coding:BodyWeightCode.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 0, "path": "Observation.code.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.code.coding:BodyWeightCode.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "1", "min": 0, "path": "Observation.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "Observation.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.subject" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.subject", "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" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.subject", "requirements": "Observations have no value if you don't know who or what they're about.", "short": "Who and/or what the observation is about", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.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](http://hl7.org/fhir/extension-observation-focuscode.html).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "id": "Observation.focus", "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" } ], "max": "0", "min": 0, "path": "Observation.focus", "short": "What the observation is about, when it is not about the subject of record", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "alias": [ "Context" ], "base": { "max": "1", "min": 0, "path": "Observation.encounter" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", "id": "Observation.encounter", "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]" } ], "max": "1", "min": 0, "path": "Observation.encounter", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "short": "Healthcare event during which this observation is made", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "alias": [ "Occurrence" ], "base": { "max": "1", "min": 0, "path": "Observation.effective[x]" }, "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](http://hl7.org/fhir/datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.", "condition": [ "vs-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "($this as dateTime).toString().length() >= 8", "human": "if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day", "key": "vs-1", "severity": "error", "xpath": "f:effectiveDateTime[matches(@value, '^\\d{4}-\\d{2}-\\d{2}')]" } ], "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "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" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.effective[x]", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.issued" }, "comment": "For Observations that don’t require review and verification, it may be the same as the [`lastUpdated` ](http://hl7.org/fhir/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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "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" } ], "max": "1", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "type": [ { "code": "instant" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.performer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who was responsible for asserting the observed value as \"true\".", "id": "Observation.performer", "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]" } ], "max": "*", "min": 0, "path": "Observation.performer", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "short": "Who is responsible for the observation", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH", "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.value[x]" }, "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](http://hl7.org/fhir/observation.html#notes) below.", "condition": [ "obs-7", "vs-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "id": "Observation.value[x]", "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|" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.value[x]", "requirements": "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", "short": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "slicing": { "discriminator": [ { "path": "$this", "type": "type" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.value[x]" }, "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](http://hl7.org/fhir/observation.html#notes) below.", "condition": [ "obs-7", "vs-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "id": "Observation.value[x]:valueQuantity", "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|" } ], "max": "1", "min": 1, "path": "Observation.value[x]", "requirements": "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", "short": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "sliceName": "valueQuantity", "type": [ { "code": "Quantity" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.value[x]:valueQuantity.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.value[x].id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.value[x]:valueQuantity.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.value[x].extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.value" }, "comment": "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", "id": "Observation.value[x]:valueQuantity.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "SN.2 / CQ - N/A" }, { "identity": "rim", "map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.value[x].value", "requirements": "Precision is handled implicitly in almost all cases of measurement.", "short": "Numerical value (with implicit precision)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.comparator" }, "binding": { "description": "How the Quantity should be understood and represented.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuantityComparator" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.", "id": "Observation.value[x]:valueQuantity.comparator", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value", "isSummary": true, "mapping": [ { "identity": "v2", "map": "SN.1 / CQ.1" }, { "identity": "rim", "map": "IVL properties" } ], "max": "1", "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "min": 0, "path": "Observation.value[x].comparator", "requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.", "short": "< | <= | >= | > - how to understand the value", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.unit" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable form of the unit.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.value[x]:valueQuantity.unit", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.value[x].unit", "requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.", "short": "Unit representation", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.system" }, "condition": [ "qty-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the system that provides the coded form of the unit.", "fixedUri": "http://unitsofmeasure.org", "id": "Observation.value[x]:valueQuantity.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "CO.codeSystem, PQ.translation.codeSystem" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.value[x].system", "requirements": "Need to know the system that defines the coded form of the unit.", "short": "System that defines coded unit form", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.code" }, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "Common UCUM units for Body Weight." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodyWeightUnits" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-bodyweight" }, "comment": "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Coded responses from the common UCUM units for vital signs value set.", "fixedCode": "Kg", "id": "Observation.value[x]:valueQuantity.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.code, MO.currency, PQ.translation.code" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.value[x].code", "requirements": "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.", "short": "Coded responses from the common UCUM units for vital signs value set.", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6", "vs-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "id": "Observation.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "0", "min": 0, "mustSupport": true, "path": "Observation.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "1", "min": 0, "path": "Observation.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.interpretation.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.interpretation.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.interpretation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.interpretation.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.interpretation.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Observation.interpretation.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.interpretation.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.interpretation.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.interpretation.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.interpretation.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Observation.interpretation.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.interpretation.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.interpretation.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.interpretation.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Observation.interpretation.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.interpretation.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.interpretation.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.interpretation.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.interpretation.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.interpretation.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.interpretation.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.interpretation.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.note" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Comments about the observation or the results.", "id": "Observation.note", "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" } ], "max": "*", "min": 0, "path": "Observation.note", "requirements": "Need to be able to provide free text additional information.", "short": "Comments about the observation", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.bodySite" }, "binding": { "description": "Codes describing anatomical locations. May include laterality.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-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](http://hl7.org/fhir/extension-bodysite.html).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the site on the subject's body where the observation was made (i.e. the target site).", "id": "Observation.bodySite", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 123037004 |Body structure|" }, { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": "targetSiteCode" }, { "identity": "sct-attr", "map": "718497002 |Inherent location|" } ], "max": "0", "min": 0, "path": "Observation.bodySite", "short": "Observed body part", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.method" }, "binding": { "description": "Methods for simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationMethod" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-methods" }, "comment": "Only used if not implicit in code for Observation.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the mechanism used to perform the observation.", "id": "Observation.method", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-17" }, { "identity": "rim", "map": "methodCode" } ], "max": "0", "min": 0, "path": "Observation.method", "requirements": "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", "short": "How it was done", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.specimen" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The specimen that was used when this observation was made.", "id": "Observation.specimen", "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|" } ], "max": "0", "min": 0, "path": "Observation.specimen", "short": "Specimen used for this observation", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.device" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The device used to generate the observation data.", "id": "Observation.device", "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|" } ], "max": "0", "min": 0, "path": "Observation.device", "short": "(Measurement) Device", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceMetric" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "low.exists() or high.exists() or text.exists()", "human": "Must have at least a low or a high or text", "key": "obs-3", "severity": "error", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))" } ], "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.", "id": "Observation.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.referenceRange", "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.", "short": "Provides guide for interpretation", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.referenceRange.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.referenceRange.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.referenceRange.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.low" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.low", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.low" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.high" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.high", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.high" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.type" }, "binding": { "description": "Code for the meaning of a reference range.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeMeaning" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-meaning" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", "id": "Observation.referenceRange.type", "isModifier": false, "isSummary": false, "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" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.type", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.", "short": "Reference range qualifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo" }, "binding": { "description": "Codes identifying the population the reference range applies to.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-appliesto" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.appliesTo", "isModifier": false, "isSummary": false, "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo", "requirements": "Need to be able to identify the target population for proper interpretation.", "short": "Reference range population", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.age" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.age", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.age", "requirements": "Some analytes vary greatly over age.", "short": "Applicable age range, if relevant", "type": [ { "code": "Range" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.text" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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\".", "id": "Observation.referenceRange.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:ST" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.hasMember" }, "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](http://hl7.org/fhir/observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](http://hl7.org/fhir/questionnaireresponse.html) into a final score and represent the score as an Observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Used when reporting vital signs panel components.", "id": "Observation.hasMember", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": "outBoundRelationship" } ], "max": "0", "min": 0, "path": "Observation.hasMember", "short": "Used when reporting vital signs panel components", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", "http://hl7.org/fhir/StructureDefinition/MolecularSequence", "http://hl7.org/fhir/StructureDefinition/vitalsigns" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.derivedFrom" }, "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](http://hl7.org/fhir/observation.html#obsgrouping) below.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.derivedFrom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": ".targetObservation" } ], "max": "0", "min": 0, "path": "Observation.derivedFrom", "short": "Related measurements the observation is made from", "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/MolecularSequence", "http://hl7.org/fhir/StructureDefinition/vitalsigns" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component" }, "comment": "For a discussion on the ways Observations can be assembled in groups together see [Notes](http://hl7.org/fhir/observation.html#notes) below.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "value.exists() or dataAbsentReason.exists()", "human": "If there is no a value a data absent reason must be present", "key": "vs-3", "severity": "error", "xpath": "f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason" } ], "definition": "Used when reporting systolic and diastolic blood pressure.", "id": "Observation.component", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "containment by OBX-4?" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=COMP]" } ], "max": "0", "min": 0, "mustSupport": true, "path": "Observation.component", "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.", "short": "Used when reporting systolic and diastolic blood pressure.", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.component.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.component.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.component.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.component.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.component.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.component.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.component.code" }, "binding": { "description": "This identifies the vital sign result type.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VitalSigns" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-vitalsignresult" }, "comment": "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "id": "Observation.component.code", "isModifier": false, "isSummary": true, "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" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.component.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Type of component observation (code / type)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.value[x]" }, "binding": { "description": "Common UCUM units for recording Vital Signs.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VitalSignsUnits" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1" }, "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](http://hl7.org/fhir/observation.html#notes) below.", "condition": [ "vs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Vital Sign Value recorded with UCUM.", "id": "Observation.component.value[x]", "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|" } ], "max": "1", "min": 0, "mustSupport": true, "path": "Observation.component.value[x]", "requirements": "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", "short": "Vital Sign Value recorded with UCUM", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6", "vs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", "id": "Observation.component.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "1", "min": 0, "mustSupport": true, "path": "Observation.component.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the component result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.component.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.component.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "*", "min": 0, "path": "Observation.component.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Observation.referenceRange", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.", "id": "Observation.component.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "*", "min": 0, "path": "Observation.component.referenceRange", "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.", "short": "Provides guide for interpretation of component result" } ] }, "status": "draft", "title": "OneHealth ObsBodyWeight", "type": "Observation", "url": "https://fhir.onehealth.com.pe/StructureDefinition/ObsBodyWeightOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/ObsBodyHeightOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/vitalsigns", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR ObsBodyHeightOH Profile, for OH interoperability scenarios, based on the national CORE Observationvitalsigns Profile defined by HL7 OH.", "differential": { "element": [ { "definition": "This profile defines how to represent Body Height observations in FHIR using a standard LOINC code and UCUM units of measure.", "id": "Observation", "path": "Observation", "short": "FHIR Body Height Profile" }, { "id": "Observation.identifier", "max": "0", "path": "Observation.identifier" }, { "id": "Observation.basedOn", "max": "0", "path": "Observation.basedOn" }, { "id": "Observation.partOf", "max": "0", "path": "Observation.partOf" }, { "id": "Observation.category:VSCat", "path": "Observation.category", "sliceName": "VSCat" }, { "id": "Observation.category:VSCat.coding.version", "max": "0", "path": "Observation.category.coding.version" }, { "id": "Observation.category:VSCat.coding.userSelected", "max": "0", "path": "Observation.category.coding.userSelected" }, { "alias": [ "Test", "Name" ], "comment": "additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system.", "definition": "Body Height.", "id": "Observation.code", "path": "Observation.code", "short": "Body Height" }, { "id": "Observation.code.coding", "min": 1, "path": "Observation.code.coding", "slicing": { "discriminator": [ { "path": "code", "type": "value" }, { "path": "system", "type": "value" } ], "ordered": false, "rules": "open" } }, { "id": "Observation.code.coding:BodyHeightCode", "max": "1", "min": 1, "path": "Observation.code.coding", "sliceName": "BodyHeightCode" }, { "fixedUri": "http://loinc.org", "id": "Observation.code.coding:BodyHeightCode.system", "min": 1, "path": "Observation.code.coding.system" }, { "fixedCode": "8302-2", "id": "Observation.code.coding:BodyHeightCode.code", "min": 1, "path": "Observation.code.coding.code" }, { "id": "Observation.subject", "path": "Observation.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Observation.focus", "max": "0", "path": "Observation.focus" }, { "id": "Observation.encounter", "path": "Observation.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "path": "Observation.effective[x]", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]" }, { "id": "Observation.performer", "path": "Observation.performer", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH", "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Observation.value[x]", "min": 1, "path": "Observation.value[x]", "slicing": { "discriminator": [ { "path": "$this", "type": "type" } ], "ordered": false, "rules": "open" } }, { "id": "Observation.value[x]:valueQuantity", "max": "1", "min": 1, "path": "Observation.value[x]", "sliceName": "valueQuantity", "type": [ { "code": "Quantity" } ] }, { "id": "Observation.value[x]:valueQuantity.value", "min": 1, "mustSupport": true, "path": "Observation.value[x].value" }, { "fixedString": "cm", "id": "Observation.value[x]:valueQuantity.unit", "min": 1, "mustSupport": true, "path": "Observation.value[x].unit" }, { "fixedUri": "http://unitsofmeasure.org", "id": "Observation.value[x]:valueQuantity.system", "min": 1, "mustSupport": true, "path": "Observation.value[x].system" }, { "binding": { "description": "Common UCUM units for body length measures such as Body Height and Head Circumference.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodyLengthUnits" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-bodylength|4.0.1" }, "definition": "Coded responses from the common UCUM units for vital signs value set.", "id": "Observation.value[x]:valueQuantity.code", "min": 1, "mustSupport": true, "path": "Observation.value[x].code", "short": "Coded responses from the common UCUM units for vital signs value set." }, { "id": "Observation.dataAbsentReason", "max": "0", "path": "Observation.dataAbsentReason" }, { "id": "Observation.interpretation", "max": "1", "path": "Observation.interpretation" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "id": "Observation.interpretation.coding.system", "min": 1, "path": "Observation.interpretation.coding.system" }, { "id": "Observation.interpretation.coding.version", "max": "0", "path": "Observation.interpretation.coding.version" }, { "id": "Observation.interpretation.coding.code", "min": 1, "path": "Observation.interpretation.coding.code" }, { "id": "Observation.interpretation.coding.display", "min": 1, "path": "Observation.interpretation.coding.display" }, { "id": "Observation.interpretation.coding.userSelected", "max": "0", "path": "Observation.interpretation.coding.userSelected" }, { "id": "Observation.interpretation.text", "max": "0", "path": "Observation.interpretation.text" }, { "id": "Observation.bodySite", "max": "0", "path": "Observation.bodySite" }, { "id": "Observation.method", "max": "0", "path": "Observation.method" }, { "id": "Observation.specimen", "max": "0", "path": "Observation.specimen" }, { "id": "Observation.device", "max": "0", "path": "Observation.device" }, { "id": "Observation.referenceRange", "max": "0", "path": "Observation.referenceRange" }, { "id": "Observation.hasMember", "max": "0", "path": "Observation.hasMember" }, { "id": "Observation.derivedFrom", "max": "0", "path": "Observation.derivedFrom" }, { "id": "Observation.component", "max": "0", "path": "Observation.component" } ] }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-summary", "valueMarkdown": "#### Complete Summary of the Mandatory Requirements\r\r1. One code in `Observation.code` which must have\r - a fixed `Observation.code.coding.system`=**'http ://loinc.org'**\r - a fixed `Observation.code.coding.code`= **'8302-2'**\r - 8306-3 -Body height - lying (i.e., body length - typically used for infants) MAY be included as an additional observation code - Other additional Codings are allowed in `Observation.code`- e.g. more specific LOINC\r Codes, SNOMED CT concepts, system specific codes. All codes\r SHALL have an system value\r1. Either one Observation.valueQuantity or, if there is no value, one code in Observation.DataAbsentReason\r - Each Observation.valueQuantity must have:\r - One numeric value in Observation.valueQuantity.value\r - a fixed Observation.valueQuantity.system=\"http://unitsofmeasure.org\"\r - a UCUM unit code in Observation.valueQuantity.code = **'cm', or '[in_i]'**" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 5 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "oo" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "fhirVersion": "4.0.1", "id": "ObsBodyHeightOH", "jurisdiction": [ { "coding": [ { "code": "PER", "display": "Perú", "system": "urn:iso:std:iso:3166" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "sct-concept", "name": "SNOMED CT Concept Domain Binding", "uri": "http://snomed.info/conceptdomain" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "sct-attr", "name": "SNOMED CT Attribute Binding", "uri": "http://snomed.org/attributebinding" } ], "meta": { "lastUpdated": "2024-04-12T17:46:24.053784+00:00", "versionId": "MTcxMjk0Mzk4NDA1Mzc4NDAwMA" }, "name": "ObsBodyHeightOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Vital Signs", "Measurement", "Results", "Tests" ], "base": { "max": "*", "min": 0, "path": "Observation" }, "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.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "dataAbsentReason.empty() or value.empty()", "human": "dataAbsentReason SHALL only be present if Observation.value[x] is not present", "key": "obs-6", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Observation", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))" }, { "expression": "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", "human": "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", "key": "obs-7", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Observation", "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]))" }, { "expression": "(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())", "human": "If there is no component or hasMember element then either a value[x] or a data absent reason must be present.", "key": "vs-2", "severity": "error", "xpath": "f:component or f:memberOF or f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason" } ], "definition": "This profile defines how to represent Body Height observations in FHIR using a standard LOINC code and UCUM units of measure.", "id": "Observation", "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]" } ], "max": "*", "min": 0, "path": "Observation", "short": "FHIR Body Height Profile" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Observation.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.implicitRules", "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, "max": "1", "min": 0, "path": "Observation.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Observation.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Observation.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Observation.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Observation.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A unique identifier assigned to this observation.", "id": "Observation.identifier", "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" } ], "max": "0", "min": 0, "path": "Observation.identifier", "requirements": "Allows observations to be distinguished and referenced.", "short": "Business Identifier for observation", "type": [ { "code": "Identifier" } ] }, { "alias": [ "Fulfills" ], "base": { "max": "*", "min": 0, "path": "Observation.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.basedOn", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "ORC" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.basedOn", "requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", "short": "Fulfills plan, proposal or order", "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" ] } ] }, { "alias": [ "Container" ], "base": { "max": "*", "min": 0, "path": "Observation.partOf" }, "comment": "To link an Observation to an Encounter use `encounter`. See the [Notes](http://hl7.org/fhir/observation.html#obsgrouping) below for guidance on referencing another Observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", "id": "Observation.partOf", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target" } ], "max": "0", "min": 0, "path": "Observation.partOf", "short": "Part of referenced event", "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" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.status" }, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Status" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-status|4.0.1" }, "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status of the result value.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final" } ], "id": "Observation.status", "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, "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\"" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.status", "requirements": "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", "short": "registered | preliminary | final | amended +", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.category" }, "binding": { "description": "Codes for high level observation categories.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCategory" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the general type of observation being made.", "id": "Observation.category", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ], "max": "*", "min": 1, "mustSupport": true, "path": "Observation.category", "requirements": "Used for filtering what observations are retrieved and displayed.", "short": "Classification of type of observation", "slicing": { "discriminator": [ { "path": "coding.code", "type": "value" }, { "path": "coding.system", "type": "value" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.category" }, "binding": { "description": "Codes for high level observation categories.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCategory" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the general type of observation being made.", "id": "Observation.category:VSCat", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.category", "requirements": "Used for filtering what observations are retrieved and displayed.", "short": "Classification of type of observation", "sliceName": "VSCat", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category:VSCat.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category:VSCat.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.category:VSCat.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 1, "mustSupport": true, "path": "Observation.category.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category:VSCat.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category:VSCat.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "fixedUri": "http://terminology.hl7.org/CodeSystem/observation-category", "id": "Observation.category:VSCat.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.category.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.category:VSCat.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.category.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "fixedCode": "vital-signs", "id": "Observation.category:VSCat.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.category.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category:VSCat.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 0, "path": "Observation.category.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.category:VSCat.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.category.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category:VSCat.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "Observation.category.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "Test", "Name" ], "base": { "max": "1", "min": 1, "path": "Observation.code" }, "binding": { "description": "This identifies the vital sign result type.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VitalSigns" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-vitalsignresult" }, "comment": "additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Body Height.", "id": "Observation.code", "isModifier": false, "isSummary": true, "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|" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.code", "requirements": "5. SHALL contain exactly one [1..1] code, where the @code SHOULD be selected from ValueSet HITSP Vital Sign Result Type 2.16.840.1.113883.3.88.12.80.62 DYNAMIC (CONF:7301).", "short": "Body Height", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 1, "path": "Observation.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "slicing": { "discriminator": [ { "path": "code", "type": "value" }, { "path": "system", "type": "value" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "Coding" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.code.coding:BodyHeightCode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Observation.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "sliceName": "BodyHeightCode", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.coding:BodyHeightCode.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.coding:BodyHeightCode.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "fixedUri": "http://loinc.org", "id": "Observation.code.coding:BodyHeightCode.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.code.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.code.coding:BodyHeightCode.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "1", "min": 0, "path": "Observation.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "fixedCode": "8302-2", "id": "Observation.code.coding:BodyHeightCode.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.code.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.coding:BodyHeightCode.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 0, "path": "Observation.code.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.code.coding:BodyHeightCode.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "1", "min": 0, "path": "Observation.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "Observation.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.subject" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.subject", "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" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.subject", "requirements": "Observations have no value if you don't know who or what they're about.", "short": "Who and/or what the observation is about", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.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](http://hl7.org/fhir/extension-observation-focuscode.html).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "id": "Observation.focus", "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" } ], "max": "0", "min": 0, "path": "Observation.focus", "short": "What the observation is about, when it is not about the subject of record", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "alias": [ "Context" ], "base": { "max": "1", "min": 0, "path": "Observation.encounter" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", "id": "Observation.encounter", "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]" } ], "max": "1", "min": 0, "path": "Observation.encounter", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "short": "Healthcare event during which this observation is made", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "alias": [ "Occurrence" ], "base": { "max": "1", "min": 0, "path": "Observation.effective[x]" }, "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](http://hl7.org/fhir/datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.", "condition": [ "vs-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "($this as dateTime).toString().length() >= 8", "human": "if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day", "key": "vs-1", "severity": "error", "xpath": "f:effectiveDateTime[matches(@value, '^\\d{4}-\\d{2}-\\d{2}')]" } ], "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "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" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.effective[x]", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.issued" }, "comment": "For Observations that don’t require review and verification, it may be the same as the [`lastUpdated` ](http://hl7.org/fhir/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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "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" } ], "max": "1", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "type": [ { "code": "instant" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.performer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who was responsible for asserting the observed value as \"true\".", "id": "Observation.performer", "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]" } ], "max": "*", "min": 0, "path": "Observation.performer", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "short": "Who is responsible for the observation", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH", "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.value[x]" }, "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](http://hl7.org/fhir/observation.html#notes) below.", "condition": [ "obs-7", "vs-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "id": "Observation.value[x]", "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|" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.value[x]", "requirements": "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", "short": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "slicing": { "discriminator": [ { "path": "$this", "type": "type" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.value[x]" }, "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](http://hl7.org/fhir/observation.html#notes) below.", "condition": [ "obs-7", "vs-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "id": "Observation.value[x]:valueQuantity", "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|" } ], "max": "1", "min": 1, "path": "Observation.value[x]", "requirements": "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", "short": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "sliceName": "valueQuantity", "type": [ { "code": "Quantity" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.value[x]:valueQuantity.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.value[x].id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.value[x]:valueQuantity.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.value[x].extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.value" }, "comment": "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", "id": "Observation.value[x]:valueQuantity.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "SN.2 / CQ - N/A" }, { "identity": "rim", "map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.value[x].value", "requirements": "Precision is handled implicitly in almost all cases of measurement.", "short": "Numerical value (with implicit precision)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.comparator" }, "binding": { "description": "How the Quantity should be understood and represented.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuantityComparator" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.", "id": "Observation.value[x]:valueQuantity.comparator", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value", "isSummary": true, "mapping": [ { "identity": "v2", "map": "SN.1 / CQ.1" }, { "identity": "rim", "map": "IVL properties" } ], "max": "1", "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "min": 0, "path": "Observation.value[x].comparator", "requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.", "short": "< | <= | >= | > - how to understand the value", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.unit" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable form of the unit.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "fixedString": "cm", "id": "Observation.value[x]:valueQuantity.unit", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.value[x].unit", "requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.", "short": "Unit representation", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.system" }, "condition": [ "qty-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the system that provides the coded form of the unit.", "fixedUri": "http://unitsofmeasure.org", "id": "Observation.value[x]:valueQuantity.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "CO.codeSystem, PQ.translation.codeSystem" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.value[x].system", "requirements": "Need to know the system that defines the coded form of the unit.", "short": "System that defines coded unit form", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.code" }, "binding": { "description": "Common UCUM units for body length measures such as Body Height and Head Circumference.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodyLengthUnits" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-bodylength|4.0.1" }, "comment": "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Coded responses from the common UCUM units for vital signs value set.", "id": "Observation.value[x]:valueQuantity.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.code, MO.currency, PQ.translation.code" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.value[x].code", "requirements": "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.", "short": "Coded responses from the common UCUM units for vital signs value set.", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6", "vs-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "id": "Observation.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "0", "min": 0, "mustSupport": true, "path": "Observation.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "1", "min": 0, "path": "Observation.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.interpretation.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.interpretation.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.interpretation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.interpretation.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.interpretation.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Observation.interpretation.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.interpretation.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.interpretation.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.interpretation.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.interpretation.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Observation.interpretation.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.interpretation.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.interpretation.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.interpretation.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Observation.interpretation.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.interpretation.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.interpretation.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.interpretation.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.interpretation.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.interpretation.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.interpretation.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.interpretation.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.note" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Comments about the observation or the results.", "id": "Observation.note", "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" } ], "max": "*", "min": 0, "path": "Observation.note", "requirements": "Need to be able to provide free text additional information.", "short": "Comments about the observation", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.bodySite" }, "binding": { "description": "Codes describing anatomical locations. May include laterality.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-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](http://hl7.org/fhir/extension-bodysite.html).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the site on the subject's body where the observation was made (i.e. the target site).", "id": "Observation.bodySite", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 123037004 |Body structure|" }, { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": "targetSiteCode" }, { "identity": "sct-attr", "map": "718497002 |Inherent location|" } ], "max": "0", "min": 0, "path": "Observation.bodySite", "short": "Observed body part", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.method" }, "binding": { "description": "Methods for simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationMethod" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-methods" }, "comment": "Only used if not implicit in code for Observation.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the mechanism used to perform the observation.", "id": "Observation.method", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-17" }, { "identity": "rim", "map": "methodCode" } ], "max": "0", "min": 0, "path": "Observation.method", "requirements": "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", "short": "How it was done", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.specimen" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The specimen that was used when this observation was made.", "id": "Observation.specimen", "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|" } ], "max": "0", "min": 0, "path": "Observation.specimen", "short": "Specimen used for this observation", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.device" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The device used to generate the observation data.", "id": "Observation.device", "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|" } ], "max": "0", "min": 0, "path": "Observation.device", "short": "(Measurement) Device", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceMetric" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "low.exists() or high.exists() or text.exists()", "human": "Must have at least a low or a high or text", "key": "obs-3", "severity": "error", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))" } ], "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.", "id": "Observation.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.referenceRange", "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.", "short": "Provides guide for interpretation", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.referenceRange.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.referenceRange.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.referenceRange.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.low" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.low", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.low" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.high" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.high", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.high" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.type" }, "binding": { "description": "Code for the meaning of a reference range.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeMeaning" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-meaning" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", "id": "Observation.referenceRange.type", "isModifier": false, "isSummary": false, "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" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.type", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.", "short": "Reference range qualifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo" }, "binding": { "description": "Codes identifying the population the reference range applies to.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-appliesto" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.appliesTo", "isModifier": false, "isSummary": false, "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo", "requirements": "Need to be able to identify the target population for proper interpretation.", "short": "Reference range population", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.age" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.age", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.age", "requirements": "Some analytes vary greatly over age.", "short": "Applicable age range, if relevant", "type": [ { "code": "Range" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.text" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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\".", "id": "Observation.referenceRange.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:ST" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.hasMember" }, "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](http://hl7.org/fhir/observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](http://hl7.org/fhir/questionnaireresponse.html) into a final score and represent the score as an Observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Used when reporting vital signs panel components.", "id": "Observation.hasMember", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": "outBoundRelationship" } ], "max": "0", "min": 0, "path": "Observation.hasMember", "short": "Used when reporting vital signs panel components", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", "http://hl7.org/fhir/StructureDefinition/MolecularSequence", "http://hl7.org/fhir/StructureDefinition/vitalsigns" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.derivedFrom" }, "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](http://hl7.org/fhir/observation.html#obsgrouping) below.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.derivedFrom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": ".targetObservation" } ], "max": "0", "min": 0, "path": "Observation.derivedFrom", "short": "Related measurements the observation is made from", "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/MolecularSequence", "http://hl7.org/fhir/StructureDefinition/vitalsigns" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component" }, "comment": "For a discussion on the ways Observations can be assembled in groups together see [Notes](http://hl7.org/fhir/observation.html#notes) below.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "value.exists() or dataAbsentReason.exists()", "human": "If there is no a value a data absent reason must be present", "key": "vs-3", "severity": "error", "xpath": "f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason" } ], "definition": "Used when reporting systolic and diastolic blood pressure.", "id": "Observation.component", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "containment by OBX-4?" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=COMP]" } ], "max": "0", "min": 0, "mustSupport": true, "path": "Observation.component", "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.", "short": "Used when reporting systolic and diastolic blood pressure.", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.component.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.component.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.component.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.component.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.component.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.component.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.component.code" }, "binding": { "description": "This identifies the vital sign result type.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VitalSigns" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-vitalsignresult" }, "comment": "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "id": "Observation.component.code", "isModifier": false, "isSummary": true, "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" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.component.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Type of component observation (code / type)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.value[x]" }, "binding": { "description": "Common UCUM units for recording Vital Signs.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VitalSignsUnits" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1" }, "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](http://hl7.org/fhir/observation.html#notes) below.", "condition": [ "vs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Vital Sign Value recorded with UCUM.", "id": "Observation.component.value[x]", "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|" } ], "max": "1", "min": 0, "mustSupport": true, "path": "Observation.component.value[x]", "requirements": "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", "short": "Vital Sign Value recorded with UCUM", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6", "vs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", "id": "Observation.component.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "1", "min": 0, "mustSupport": true, "path": "Observation.component.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the component result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.component.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.component.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "*", "min": 0, "path": "Observation.component.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Observation.referenceRange", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.", "id": "Observation.component.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "*", "min": 0, "path": "Observation.component.referenceRange", "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.", "short": "Provides guide for interpretation of component result" } ] }, "status": "draft", "title": "OneHealth ObsBodyHeight", "type": "Observation", "url": "https://fhir.onehealth.com.pe/StructureDefinition/ObsBodyHeightOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/ObsBloodGroupOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR ObsBloodGroupOH Profile, for OH interoperability scenarios, based on the national CORE Observation Profile defined by HL7 OH..", "differential": { "element": [ { "id": "Observation.identifier", "max": "0", "path": "Observation.identifier" }, { "id": "Observation.basedOn", "max": "0", "path": "Observation.basedOn" }, { "id": "Observation.partOf", "max": "0", "path": "Observation.partOf" }, { "definition": "Estado de la observación.Valor por defecto: final", "id": "Observation.status", "path": "Observation.status", "patternCode": "final", "short": "Estado de la observación. Valor por defecto: final" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "id": "Observation.category", "max": "1", "min": 1, "path": "Observation.category" }, { "id": "Observation.category.coding.system", "min": 1, "path": "Observation.category.coding.system" }, { "id": "Observation.category.coding.version", "max": "0", "path": "Observation.category.coding.version" }, { "fixedCode": "laboratory", "id": "Observation.category.coding.code", "min": 1, "path": "Observation.category.coding.code" }, { "id": "Observation.category.coding.display", "min": 1, "path": "Observation.category.coding.display" }, { "id": "Observation.category.coding.userSelected", "max": "0", "path": "Observation.category.coding.userSelected" }, { "id": "Observation.category.text", "max": "0", "path": "Observation.category.text" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "definition": "Código que identifica la observación como grupo sanguíneo.", "id": "Observation.code", "path": "Observation.code", "short": "Código que identifica la observación como grupo sanguíneo." }, { "id": "Observation.code.coding", "max": "1", "min": 1, "path": "Observation.code.coding" }, { "definition": "Sistema que define la codificación.Valor por defecto: http://loinc.org", "id": "Observation.code.coding.system", "min": 1, "path": "Observation.code.coding.system", "patternUri": "http://loinc.org", "short": "Sistema que define la codificación.Valor por defecto: http://loinc.org" }, { "id": "Observation.code.coding.version", "max": "0", "path": "Observation.code.coding.version" }, { "definition": "Código.Valor por defecto: 883-9", "id": "Observation.code.coding.code", "min": 1, "path": "Observation.code.coding.code", "patternCode": "883-9", "short": "Código.Valor por defecto: 883-9" }, { "definition": "Descripción del código.Valor por defecto: Grupo sanguíneo del sistema ABO", "id": "Observation.code.coding.display", "min": 1, "path": "Observation.code.coding.display", "patternString": "grupo ABO:tipo:punto en el tiempo:sangre:Nominal:", "short": "grupo ABO" }, { "id": "Observation.code.coding.userSelected", "max": "0", "path": "Observation.code.coding.userSelected" }, { "id": "Observation.code.text", "max": "0", "path": "Observation.code.text" }, { "id": "Observation.subject", "min": 1, "path": "Observation.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Observation.focus", "max": "0", "path": "Observation.focus" }, { "id": "Observation.encounter", "path": "Observation.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "min": 1, "path": "Observation.effective[x]", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]" }, { "id": "Observation.performer", "max": "1", "min": 1, "path": "Observation.performer", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/BloodGroupsValueSetOH" }, "definition": "Example value 'A' [ES: Ejemplo de valor 'A']", "id": "Observation.value[x]", "min": 1, "path": "Observation.value[x]", "short": "Example value 'A' [ES: Ejemplo de valor 'A']", "type": [ { "code": "CodeableConcept" } ] }, { "id": "Observation.value[x].coding", "max": "1", "min": 1, "path": "Observation.value[x].coding" }, { "definition": "Sistema que define la codificación.Valor por defecto: http://snomed.info/sct", "id": "Observation.value[x].coding.system", "min": 1, "path": "Observation.value[x].coding.system", "short": "Sistema que define la codificación.Valor por defecto: http://snomed.info/sct" }, { "id": "Observation.value[x].coding.version", "max": "0", "path": "Observation.value[x].coding.version" }, { "definition": "Código. Valor de ejemplo: 112144000", "id": "Observation.value[x].coding.code", "min": 1, "path": "Observation.value[x].coding.code", "short": "Código. Valor de ejemplo: 112144000" }, { "definition": "Descripción del código.Valor de ejemplo: Blood group A (finding)", "id": "Observation.value[x].coding.display", "min": 1, "path": "Observation.value[x].coding.display", "short": "Descripción del código. Valor de ejemplo: Blood group A (finding)" }, { "id": "Observation.value[x].coding.userSelected", "max": "0", "path": "Observation.value[x].coding.userSelected" }, { "id": "Observation.value[x].text", "max": "0", "path": "Observation.value[x].text" }, { "id": "Observation.dataAbsentReason", "max": "0", "path": "Observation.dataAbsentReason" }, { "id": "Observation.interpretation", "max": "0", "path": "Observation.interpretation" }, { "id": "Observation.bodySite", "max": "0", "path": "Observation.bodySite" }, { "id": "Observation.method", "max": "0", "path": "Observation.method" }, { "id": "Observation.specimen", "max": "0", "path": "Observation.specimen" }, { "id": "Observation.device", "max": "0", "path": "Observation.device" }, { "id": "Observation.referenceRange", "max": "0", "path": "Observation.referenceRange" }, { "id": "Observation.hasMember", "max": "0", "path": "Observation.hasMember" }, { "id": "Observation.derivedFrom", "max": "0", "path": "Observation.derivedFrom" }, { "id": "Observation.component", "max": "0", "path": "Observation.component" } ] }, "fhirVersion": "4.0.1", "id": "ObsBloodGroupOH", "jurisdiction": [ { "coding": [ { "code": "PER", "display": "Perú", "system": "urn:iso:std:iso:3166" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "sct-concept", "name": "SNOMED CT Concept Domain Binding", "uri": "http://snomed.info/conceptdomain" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "sct-attr", "name": "SNOMED CT Attribute Binding", "uri": "http://snomed.org/attributebinding" } ], "meta": { "lastUpdated": "2024-04-12T17:46:23.797684+00:00", "versionId": "MTcxMjk0Mzk4Mzc5NzY4NDAwMA" }, "name": "ObsBloodGroupOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Vital Signs", "Measurement", "Results", "Tests" ], "base": { "max": "*", "min": 0, "path": "Observation" }, "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.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "dataAbsentReason.empty() or value.empty()", "human": "dataAbsentReason SHALL only be present if Observation.value[x] is not present", "key": "obs-6", "severity": "error", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))" }, { "expression": "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", "human": "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", "key": "obs-7", "severity": "error", "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]))" } ], "definition": "Measurements and simple assertions made about a patient, device or other subject.", "id": "Observation", "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]" } ], "max": "*", "min": 0, "path": "Observation", "short": "Measurements and simple assertions" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Observation.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.implicitRules", "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, "max": "1", "min": 0, "path": "Observation.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Observation.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Observation.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Observation.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Observation.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A unique identifier assigned to this observation.", "id": "Observation.identifier", "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" } ], "max": "0", "min": 0, "path": "Observation.identifier", "requirements": "Allows observations to be distinguished and referenced.", "short": "Business Identifier for observation", "type": [ { "code": "Identifier" } ] }, { "alias": [ "Fulfills" ], "base": { "max": "*", "min": 0, "path": "Observation.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.basedOn", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "ORC" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.basedOn", "requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", "short": "Fulfills plan, proposal or order", "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" ] } ] }, { "alias": [ "Container" ], "base": { "max": "*", "min": 0, "path": "Observation.partOf" }, "comment": "To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", "id": "Observation.partOf", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target" } ], "max": "0", "min": 0, "path": "Observation.partOf", "short": "Part of referenced event", "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" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.status" }, "binding": { "description": "Codes providing the status of an observation.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-status|4.0.1" }, "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Estado de la observación.Valor por defecto: final", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final" } ], "id": "Observation.status", "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, "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\"" } ], "max": "1", "min": 1, "path": "Observation.status", "patternCode": "final", "requirements": "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", "short": "Estado de la observación. Valor por defecto: final", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.category" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the general type of observation being made.", "id": "Observation.category", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ], "max": "1", "min": 1, "path": "Observation.category", "requirements": "Used for filtering what observations are retrieved and displayed.", "short": "Classification of type of observation", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.category.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Observation.category.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Observation.category.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.category.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.category.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.category.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "fixedCode": "laboratory", "id": "Observation.category.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.category.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.category.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.category.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.category.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.category.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "Name" ], "base": { "max": "1", "min": 1, "path": "Observation.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código que identifica la observación como grupo sanguíneo.", "id": "Observation.code", "isModifier": false, "isSummary": true, "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|" } ], "max": "1", "min": 1, "path": "Observation.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Código que identifica la observación como grupo sanguíneo.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Observation.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Sistema que define la codificación.Valor por defecto: http://loinc.org", "id": "Observation.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.code.coding.system", "patternUri": "http://loinc.org", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Sistema que define la codificación.Valor por defecto: http://loinc.org", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código.Valor por defecto: 883-9", "id": "Observation.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.code.coding.code", "patternCode": "883-9", "requirements": "Need to refer to a particular code in the system.", "short": "Código.Valor por defecto: 883-9", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Descripción del código.Valor por defecto: Grupo sanguíneo del sistema ABO", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.code.coding.display", "patternString": "grupo ABO:tipo:punto en el tiempo:sangre:Nominal:", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "grupo ABO", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.subject" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.subject", "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" } ], "max": "1", "min": 1, "path": "Observation.subject", "requirements": "Observations have no value if you don't know who or what they're about.", "short": "Who and/or what the observation is about", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "id": "Observation.focus", "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" } ], "max": "0", "min": 0, "path": "Observation.focus", "short": "What the observation is about, when it is not about the subject of record", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "alias": [ "Context" ], "base": { "max": "1", "min": 0, "path": "Observation.encounter" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", "id": "Observation.encounter", "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]" } ], "max": "1", "min": 0, "path": "Observation.encounter", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "short": "Healthcare event during which this observation is made", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "alias": [ "Occurrence" ], "base": { "max": "1", "min": 0, "path": "Observation.effective[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "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" } ], "max": "1", "min": 1, "path": "Observation.effective[x]", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.issued" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "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" } ], "max": "1", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "type": [ { "code": "instant" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.performer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who was responsible for asserting the observed value as \"true\".", "id": "Observation.performer", "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]" } ], "max": "1", "min": 1, "path": "Observation.performer", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "short": "Who is responsible for the observation", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.value[x]" }, "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/BloodGroupsValueSetOH" }, "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.", "condition": [ "obs-7" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Example value 'A' [ES: Ejemplo de valor 'A']", "id": "Observation.value[x]", "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|" } ], "max": "1", "min": 1, "path": "Observation.value[x]", "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.", "short": "Example value 'A' [ES: Ejemplo de valor 'A']", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.value[x].id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.value[x].id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.value[x].extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.value[x].extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.value[x].coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Observation.value[x].coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.value[x].coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.value[x].coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.value[x].coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.value[x].coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Sistema que define la codificación.Valor por defecto: http://snomed.info/sct", "id": "Observation.value[x].coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.value[x].coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Sistema que define la codificación.Valor por defecto: http://snomed.info/sct", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.value[x].coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.value[x].coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Código. Valor de ejemplo: 112144000", "id": "Observation.value[x].coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.value[x].coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Código. Valor de ejemplo: 112144000", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Descripción del código.Valor de ejemplo: Blood group A (finding)", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.value[x].coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Observation.value[x].coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Descripción del código. Valor de ejemplo: Blood group A (finding)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.value[x].coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.value[x].coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.value[x].text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.value[x].text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "id": "Observation.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "0", "min": 0, "path": "Observation.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "0", "min": 0, "path": "Observation.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.note" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Comments about the observation or the results.", "id": "Observation.note", "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" } ], "max": "*", "min": 0, "path": "Observation.note", "requirements": "Need to be able to provide free text additional information.", "short": "Comments about the observation", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.bodySite" }, "binding": { "description": "Codes describing anatomical locations. May include laterality.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the site on the subject's body where the observation was made (i.e. the target site).", "id": "Observation.bodySite", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 123037004 |Body structure|" }, { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": "targetSiteCode" }, { "identity": "sct-attr", "map": "718497002 |Inherent location|" } ], "max": "0", "min": 0, "path": "Observation.bodySite", "short": "Observed body part", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.method" }, "binding": { "description": "Methods for simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationMethod" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-methods" }, "comment": "Only used if not implicit in code for Observation.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the mechanism used to perform the observation.", "id": "Observation.method", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-17" }, { "identity": "rim", "map": "methodCode" } ], "max": "0", "min": 0, "path": "Observation.method", "requirements": "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", "short": "How it was done", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.specimen" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The specimen that was used when this observation was made.", "id": "Observation.specimen", "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|" } ], "max": "0", "min": 0, "path": "Observation.specimen", "short": "Specimen used for this observation", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.device" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The device used to generate the observation data.", "id": "Observation.device", "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|" } ], "max": "0", "min": 0, "path": "Observation.device", "short": "(Measurement) Device", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceMetric" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "low.exists() or high.exists() or text.exists()", "human": "Must have at least a low or a high or text", "key": "obs-3", "severity": "error", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))" } ], "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.", "id": "Observation.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.referenceRange", "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.", "short": "Provides guide for interpretation", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.referenceRange.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.referenceRange.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.referenceRange.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.low" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.low", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.low" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.high" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.high", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.high" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.type" }, "binding": { "description": "Code for the meaning of a reference range.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeMeaning" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-meaning" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", "id": "Observation.referenceRange.type", "isModifier": false, "isSummary": false, "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" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.type", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.", "short": "Reference range qualifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo" }, "binding": { "description": "Codes identifying the population the reference range applies to.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-appliesto" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.appliesTo", "isModifier": false, "isSummary": false, "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo", "requirements": "Need to be able to identify the target population for proper interpretation.", "short": "Reference range population", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.age" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.age", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.age", "requirements": "Some analytes vary greatly over age.", "short": "Applicable age range, if relevant", "type": [ { "code": "Range" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.text" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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\".", "id": "Observation.referenceRange.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:ST" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.hasMember" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.hasMember", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": "outBoundRelationship" } ], "max": "0", "min": 0, "path": "Observation.hasMember", "short": "Related resource that belongs to the Observation group", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", "http://hl7.org/fhir/StructureDefinition/MolecularSequence" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.derivedFrom" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.derivedFrom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": ".targetObservation" } ], "max": "0", "min": 0, "path": "Observation.derivedFrom", "short": "Related measurements the observation is made from", "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" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component" }, "comment": "For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.component", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "containment by OBX-4?" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=COMP]" } ], "max": "0", "min": 0, "path": "Observation.component", "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.", "short": "Component results", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.component.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.component.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.component.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.component.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.component.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.component.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.component.code" }, "binding": { "description": "Codes identifying names of simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCode" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "comment": "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "id": "Observation.component.code", "isModifier": false, "isSummary": true, "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" } ], "max": "1", "min": 1, "path": "Observation.component.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Type of component observation (code / type)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.value[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The information determined as a result of making the observation, if the information has a simple value.", "id": "Observation.component.value[x]", "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|" } ], "max": "1", "min": 0, "path": "Observation.component.value[x]", "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.", "short": "Actual component result", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", "id": "Observation.component.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the component result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.component.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.component.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "*", "min": 0, "path": "Observation.component.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Observation.referenceRange", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.", "id": "Observation.component.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "*", "min": 0, "path": "Observation.component.referenceRange", "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.", "short": "Provides guide for interpretation of component result" } ] }, "status": "draft", "title": "OneHealth ObsBloodGroup", "type": "Observation", "url": "https://fhir.onehealth.com.pe/StructureDefinition/ObsBloodGroupOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/ObsBasicLaboratoryOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR ObsBasicLaboratoryOH Profile, for OH interoperability scenarios, based on the national CORE Observation Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Observation.identifier", "max": "1", "min": 1, "path": "Observation.identifier" }, { "definition": "The purpose of this identifier. [ES: Valor por defect \"usual\"]", "id": "Observation.identifier.use", "path": "Observation.identifier.use", "patternCode": "usual", "short": "The purpose of this identifier. [ES: Valor por defect \"usual\"]" }, { "id": "Observation.identifier.type", "max": "0", "path": "Observation.identifier.type" }, { "id": "Observation.identifier.system", "max": "0", "path": "Observation.identifier.system" }, { "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: Identificador único del resultado de laboratorio. ]", "id": "Observation.identifier.value", "path": "Observation.identifier.value", "short": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: Identificador único del resultado de laboratorio. ]" }, { "id": "Observation.identifier.period", "max": "0", "path": "Observation.identifier.period" }, { "id": "Observation.identifier.assigner", "max": "0", "path": "Observation.identifier.assigner" }, { "id": "Observation.basedOn", "max": "0", "path": "Observation.basedOn" }, { "id": "Observation.partOf", "max": "0", "path": "Observation.partOf" }, { "definition": "The status of the result value. [ES: Valor por dfecto \"final\"]", "id": "Observation.status", "path": "Observation.status", "patternCode": "final", "short": "The status of the result value. [ES: Valor por dfecto \"final\"]" }, { "id": "Observation.category", "max": "1", "min": 1, "path": "Observation.category" }, { "definition": "The identification of the code system that defines the meaning of the symbol in the code. [ES: Valor por defecto \"http://terminology.hl7.org/CodeSystem/observation-category\"]", "id": "Observation.category.coding.system", "path": "Observation.category.coding.system", "patternUri": "http://terminology.hl7.org/CodeSystem/observation-category", "short": "The identification of the code system that defines the meaning of the symbol in the code. [ES: Valor por defecto \"http://terminology.hl7.org/CodeSystem/observation-category\"]" }, { "id": "Observation.category.coding.version", "max": "0", "path": "Observation.category.coding.version" }, { "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). [ES: Valor por defecto \"laboratory\"]", "id": "Observation.category.coding.code", "path": "Observation.category.coding.code", "patternCode": "laboratory", "short": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). [ES: Valor por defecto \"laboratory\"]" }, { "definition": "A representation of the meaning of the code in the system, following the rules of the system. [ES: Valor por defecto \"Laboratory\"]", "id": "Observation.category.coding.display", "path": "Observation.category.coding.display", "patternString": "Laboratory", "short": "A representation of the meaning of the code in the system, following the rules of the system. [ES: Valor por defecto \"Laboratory\"]" }, { "id": "Observation.category.coding.userSelected", "max": "0", "path": "Observation.category.coding.userSelected" }, { "id": "Observation.category.text", "max": "0", "path": "Observation.category.text" }, { "id": "Observation.subject", "min": 1, "path": "Observation.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Observation.focus", "max": "0", "path": "Observation.focus" }, { "id": "Observation.encounter", "max": "0", "path": "Observation.encounter" }, { "id": "Observation.effective[x]", "max": "0", "path": "Observation.effective[x]" }, { "id": "Observation.issued", "max": "0", "path": "Observation.issued" }, { "id": "Observation.performer", "max": "1", "min": 1, "path": "Observation.performer", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "Observation.value[x]", "path": "Observation.value[x]", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" } ] }, { "id": "Observation.dataAbsentReason", "max": "0", "path": "Observation.dataAbsentReason" }, { "id": "Observation.interpretation", "max": "0", "path": "Observation.interpretation" }, { "id": "Observation.note", "max": "0", "path": "Observation.note" }, { "id": "Observation.bodySite", "max": "0", "path": "Observation.bodySite" }, { "id": "Observation.method", "max": "0", "path": "Observation.method" }, { "id": "Observation.specimen", "max": "0", "path": "Observation.specimen" }, { "id": "Observation.referenceRange", "max": "1", "path": "Observation.referenceRange" }, { "id": "Observation.hasMember", "max": "0", "path": "Observation.hasMember" }, { "id": "Observation.derivedFrom", "max": "0", "path": "Observation.derivedFrom" }, { "id": "Observation.component", "max": "0", "path": "Observation.component" } ] }, "fhirVersion": "4.0.1", "id": "ObsBasicLaboratoryOH", "jurisdiction": [ { "coding": [ { "code": "PER", "display": "Perú", "system": "urn:iso:std:iso:3166" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "sct-concept", "name": "SNOMED CT Concept Domain Binding", "uri": "http://snomed.info/conceptdomain" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "sct-attr", "name": "SNOMED CT Attribute Binding", "uri": "http://snomed.org/attributebinding" } ], "meta": { "lastUpdated": "2024-04-12T17:46:23.531184+00:00", "versionId": "MTcxMjk0Mzk4MzUzMTE4NDAwMA" }, "name": "ObsBasicLaboratoryOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Vital Signs", "Measurement", "Results", "Tests" ], "base": { "max": "*", "min": 0, "path": "Observation" }, "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.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "dataAbsentReason.empty() or value.empty()", "human": "dataAbsentReason SHALL only be present if Observation.value[x] is not present", "key": "obs-6", "severity": "error", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))" }, { "expression": "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", "human": "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", "key": "obs-7", "severity": "error", "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]))" } ], "definition": "Measurements and simple assertions made about a patient, device or other subject.", "id": "Observation", "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]" } ], "max": "*", "min": 0, "path": "Observation", "short": "Measurements and simple assertions" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Observation.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.implicitRules", "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, "max": "1", "min": 0, "path": "Observation.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Observation.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Observation.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Observation.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Observation.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A unique identifier assigned to this observation.", "id": "Observation.identifier", "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" } ], "max": "1", "min": 1, "path": "Observation.identifier", "requirements": "Allows observations to be distinguished and referenced.", "short": "Business Identifier for observation", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier. [ES: Valor por defect \"usual\"]", "id": "Observation.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 0, "path": "Observation.identifier.use", "patternCode": "usual", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "The purpose of this identifier. [ES: Valor por defect \"usual\"]", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "Observation.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "Observation.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "Observation.identifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "0", "min": 0, "path": "Observation.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: Identificador único del resultado de laboratorio. ]", "example": [ { "label": "General", "valueString": "123456" } ], "id": "Observation.identifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 0, "path": "Observation.identifier.value", "short": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: Identificador único del resultado de laboratorio. ]", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "Observation.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Observation.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "Observation.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "0", "min": 0, "path": "Observation.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "alias": [ "Fulfills" ], "base": { "max": "*", "min": 0, "path": "Observation.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.basedOn", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "ORC" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.basedOn", "requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", "short": "Fulfills plan, proposal or order", "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" ] } ] }, { "alias": [ "Container" ], "base": { "max": "*", "min": 0, "path": "Observation.partOf" }, "comment": "To link an Observation to an Encounter use `encounter`. See the [Notes](observation.html#obsgrouping) below for guidance on referencing another Observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", "id": "Observation.partOf", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target" } ], "max": "0", "min": 0, "path": "Observation.partOf", "short": "Part of referenced event", "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" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.status" }, "binding": { "description": "Codes providing the status of an observation.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-status|4.0.1" }, "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status of the result value. [ES: Valor por dfecto \"final\"]", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final" } ], "id": "Observation.status", "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, "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\"" } ], "max": "1", "min": 1, "path": "Observation.status", "patternCode": "final", "requirements": "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", "short": "The status of the result value. [ES: Valor por dfecto \"final\"]", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.category" }, "binding": { "description": "Codes for high level observation categories.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCategory" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the general type of observation being made.", "id": "Observation.category", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ], "max": "1", "min": 1, "path": "Observation.category", "requirements": "Used for filtering what observations are retrieved and displayed.", "short": "Classification of type of observation", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.category.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Observation.category.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code. [ES: Valor por defecto \"http://terminology.hl7.org/CodeSystem/observation-category\"]", "id": "Observation.category.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 0, "path": "Observation.category.coding.system", "patternUri": "http://terminology.hl7.org/CodeSystem/observation-category", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "The identification of the code system that defines the meaning of the symbol in the code. [ES: Valor por defecto \"http://terminology.hl7.org/CodeSystem/observation-category\"]", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.category.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.category.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). [ES: Valor por defecto \"laboratory\"]", "id": "Observation.category.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 0, "path": "Observation.category.coding.code", "patternCode": "laboratory", "requirements": "Need to refer to a particular code in the system.", "short": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). [ES: Valor por defecto \"laboratory\"]", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system. [ES: Valor por defecto \"Laboratory\"]", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 0, "path": "Observation.category.coding.display", "patternString": "Laboratory", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "A representation of the meaning of the code in the system, following the rules of the system. [ES: Valor por defecto \"Laboratory\"]", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.category.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.category.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Observation.category.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "Name" ], "base": { "max": "1", "min": 1, "path": "Observation.code" }, "binding": { "description": "Codes identifying names of simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCode" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes what was observed. Sometimes this is called the observation \"name\".", "id": "Observation.code", "isModifier": false, "isSummary": true, "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|" } ], "max": "1", "min": 1, "path": "Observation.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Type of observation (code / type)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.subject" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.subject", "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" } ], "max": "1", "min": 1, "path": "Observation.subject", "requirements": "Observations have no value if you don't know who or what they're about.", "short": "Who and/or what the observation is about", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "id": "Observation.focus", "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" } ], "max": "0", "min": 0, "path": "Observation.focus", "short": "What the observation is about, when it is not about the subject of record", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "alias": [ "Context" ], "base": { "max": "1", "min": 0, "path": "Observation.encounter" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", "id": "Observation.encounter", "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]" } ], "max": "0", "min": 0, "path": "Observation.encounter", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "short": "Healthcare event during which this observation is made", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ] }, { "alias": [ "Occurrence" ], "base": { "max": "1", "min": 0, "path": "Observation.effective[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.effective[x]", "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" } ], "max": "0", "min": 0, "path": "Observation.effective[x]", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "short": "Clinically relevant time/time-period for observation", "type": [ { "code": "dateTime" }, { "code": "Period" }, { "code": "Timing" }, { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.issued" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.", "id": "Observation.issued", "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" } ], "max": "0", "min": 0, "path": "Observation.issued", "short": "Date/Time this version was made available", "type": [ { "code": "instant" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.performer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who was responsible for asserting the observed value as \"true\".", "id": "Observation.performer", "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]" } ], "max": "1", "min": 1, "path": "Observation.performer", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "short": "Who is responsible for the observation", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.value[x]" }, "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.", "condition": [ "obs-7" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The information determined as a result of making the observation, if the information has a simple value.", "id": "Observation.value[x]", "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|" } ], "max": "1", "min": 0, "path": "Observation.value[x]", "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.", "short": "Actual result", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "id": "Observation.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "0", "min": 0, "path": "Observation.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "0", "min": 0, "path": "Observation.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.note" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Comments about the observation or the results.", "id": "Observation.note", "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" } ], "max": "0", "min": 0, "path": "Observation.note", "requirements": "Need to be able to provide free text additional information.", "short": "Comments about the observation", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.bodySite" }, "binding": { "description": "Codes describing anatomical locations. May include laterality.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the site on the subject's body where the observation was made (i.e. the target site).", "id": "Observation.bodySite", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 123037004 |Body structure|" }, { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": "targetSiteCode" }, { "identity": "sct-attr", "map": "718497002 |Inherent location|" } ], "max": "0", "min": 0, "path": "Observation.bodySite", "short": "Observed body part", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.method" }, "binding": { "description": "Methods for simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationMethod" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-methods" }, "comment": "Only used if not implicit in code for Observation.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the mechanism used to perform the observation.", "id": "Observation.method", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-17" }, { "identity": "rim", "map": "methodCode" } ], "max": "0", "min": 0, "path": "Observation.method", "requirements": "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", "short": "How it was done", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.specimen" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The specimen that was used when this observation was made.", "id": "Observation.specimen", "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|" } ], "max": "0", "min": 0, "path": "Observation.specimen", "short": "Specimen used for this observation", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.device" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The device used to generate the observation data.", "id": "Observation.device", "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|" } ], "max": "1", "min": 0, "path": "Observation.device", "short": "(Measurement) Device", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceMetric" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "low.exists() or high.exists() or text.exists()", "human": "Must have at least a low or a high or text", "key": "obs-3", "severity": "error", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))" } ], "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.", "id": "Observation.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "1", "min": 0, "path": "Observation.referenceRange", "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.", "short": "Provides guide for interpretation", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.referenceRange.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.referenceRange.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.referenceRange.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.low" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.low", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.low" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.high" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.high", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.high" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.type" }, "binding": { "description": "Code for the meaning of a reference range.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeMeaning" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-meaning" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", "id": "Observation.referenceRange.type", "isModifier": false, "isSummary": false, "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" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.type", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.", "short": "Reference range qualifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo" }, "binding": { "description": "Codes identifying the population the reference range applies to.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-appliesto" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.appliesTo", "isModifier": false, "isSummary": false, "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo", "requirements": "Need to be able to identify the target population for proper interpretation.", "short": "Reference range population", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.age" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.age", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.age", "requirements": "Some analytes vary greatly over age.", "short": "Applicable age range, if relevant", "type": [ { "code": "Range" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.text" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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\".", "id": "Observation.referenceRange.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:ST" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.hasMember" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.hasMember", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": "outBoundRelationship" } ], "max": "0", "min": 0, "path": "Observation.hasMember", "short": "Related resource that belongs to the Observation group", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", "http://hl7.org/fhir/StructureDefinition/MolecularSequence" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.derivedFrom" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.derivedFrom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": ".targetObservation" } ], "max": "0", "min": 0, "path": "Observation.derivedFrom", "short": "Related measurements the observation is made from", "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" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component" }, "comment": "For a discussion on the ways Observations can be assembled in groups together see [Notes](observation.html#notes) below.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.component", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "containment by OBX-4?" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=COMP]" } ], "max": "0", "min": 0, "path": "Observation.component", "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.", "short": "Component results", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.component.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.component.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.component.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.component.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.component.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.component.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.component.code" }, "binding": { "description": "Codes identifying names of simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCode" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "comment": "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "id": "Observation.component.code", "isModifier": false, "isSummary": true, "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" } ], "max": "1", "min": 1, "path": "Observation.component.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Type of component observation (code / type)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.value[x]" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The information determined as a result of making the observation, if the information has a simple value.", "id": "Observation.component.value[x]", "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|" } ], "max": "1", "min": 0, "path": "Observation.component.value[x]", "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.", "short": "Actual component result", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", "id": "Observation.component.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the component result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.component.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.component.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "*", "min": 0, "path": "Observation.component.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Observation.referenceRange", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.", "id": "Observation.component.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "*", "min": 0, "path": "Observation.component.referenceRange", "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.", "short": "Provides guide for interpretation of component result" } ] }, "status": "draft", "title": "OneHealth ObsBasicLaboratory", "type": "Observation", "url": "https://fhir.onehealth.com.pe/StructureDefinition/ObsBasicLaboratoryOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/ObsBMIOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/vitalsigns", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR ObsBMIOH Profile, for OH interoperability scenarios, based on the national CORE Observationvitalsigns Profile defined by HL7 OH.", "differential": { "element": [ { "definition": "This profile defines how to represent Body Mass Index (BMI) observations in FHIR using a standard LOINC code and UCUM units of measure.", "id": "Observation", "path": "Observation", "short": "FHIR Body Mass Index (BMI) Profile" }, { "id": "Observation.identifier", "max": "0", "path": "Observation.identifier" }, { "id": "Observation.basedOn", "max": "0", "path": "Observation.basedOn" }, { "id": "Observation.partOf", "max": "0", "path": "Observation.partOf" }, { "id": "Observation.category:VSCat", "path": "Observation.category", "sliceName": "VSCat" }, { "id": "Observation.category:VSCat.coding.version", "max": "0", "path": "Observation.category.coding.version" }, { "id": "Observation.category:VSCat.coding.userSelected", "max": "0", "path": "Observation.category.coding.userSelected" }, { "alias": [ "Test", "Name" ], "comment": "additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system.", "definition": "Body Mass Index (BMI).", "id": "Observation.code", "path": "Observation.code", "short": "Body Mass Index (BMI)" }, { "id": "Observation.code.coding", "min": 1, "path": "Observation.code.coding", "slicing": { "discriminator": [ { "path": "code", "type": "value" }, { "path": "system", "type": "value" } ], "ordered": false, "rules": "open" } }, { "id": "Observation.code.coding:BMICode", "max": "1", "min": 1, "path": "Observation.code.coding", "sliceName": "BMICode" }, { "fixedUri": "http://loinc.org", "id": "Observation.code.coding:BMICode.system", "min": 1, "path": "Observation.code.coding.system" }, { "fixedCode": "39156-5", "id": "Observation.code.coding:BMICode.code", "min": 1, "path": "Observation.code.coding.code" }, { "id": "Observation.subject", "path": "Observation.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Observation.focus", "max": "0", "path": "Observation.focus" }, { "id": "Observation.encounter", "path": "Observation.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "path": "Observation.effective[x]", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]" }, { "id": "Observation.performer", "path": "Observation.performer", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "Observation.value[x]", "min": 1, "path": "Observation.value[x]", "slicing": { "discriminator": [ { "path": "$this", "type": "type" } ], "ordered": false, "rules": "open" } }, { "id": "Observation.value[x]:valueQuantity", "max": "1", "min": 1, "path": "Observation.value[x]", "sliceName": "valueQuantity", "type": [ { "code": "Quantity" } ] }, { "id": "Observation.value[x]:valueQuantity.value", "min": 1, "path": "Observation.value[x].value" }, { "id": "Observation.value[x]:valueQuantity.unit", "min": 1, "path": "Observation.value[x].unit" }, { "fixedUri": "http://unitsofmeasure.org", "id": "Observation.value[x]:valueQuantity.system", "min": 1, "path": "Observation.value[x].system" }, { "definition": "Coded responses from the common UCUM units for vital signs value set.", "fixedCode": "kg/m2", "id": "Observation.value[x]:valueQuantity.code", "min": 1, "path": "Observation.value[x].code", "short": "Coded responses from the common UCUM units for vital signs value set." }, { "id": "Observation.dataAbsentReason", "max": "0", "path": "Observation.dataAbsentReason" }, { "id": "Observation.interpretation", "max": "0", "path": "Observation.interpretation" }, { "id": "Observation.bodySite", "max": "0", "path": "Observation.bodySite" }, { "id": "Observation.method", "max": "0", "path": "Observation.method" }, { "id": "Observation.specimen", "max": "0", "path": "Observation.specimen" }, { "id": "Observation.device", "max": "0", "path": "Observation.device" }, { "id": "Observation.referenceRange", "max": "0", "path": "Observation.referenceRange" }, { "id": "Observation.hasMember", "max": "0", "path": "Observation.hasMember" }, { "id": "Observation.derivedFrom", "max": "0", "path": "Observation.derivedFrom" }, { "id": "Observation.component", "max": "0", "path": "Observation.component" } ] }, "fhirVersion": "4.0.1", "id": "ObsBMIOH", "jurisdiction": [ { "coding": [ { "code": "PER", "display": "Perú", "system": "urn:iso:std:iso:3166" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "sct-concept", "name": "SNOMED CT Concept Domain Binding", "uri": "http://snomed.info/conceptdomain" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "sct-attr", "name": "SNOMED CT Attribute Binding", "uri": "http://snomed.org/attributebinding" } ], "meta": { "lastUpdated": "2024-04-12T17:46:23.260274+00:00", "versionId": "MTcxMjk0Mzk4MzI2MDI3NDAwMA" }, "name": "ObsBMIOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Vital Signs", "Measurement", "Results", "Tests" ], "base": { "max": "*", "min": 0, "path": "Observation" }, "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.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "dataAbsentReason.empty() or value.empty()", "human": "dataAbsentReason SHALL only be present if Observation.value[x] is not present", "key": "obs-6", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Observation", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))" }, { "expression": "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", "human": "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", "key": "obs-7", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Observation", "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]))" }, { "expression": "(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())", "human": "If there is no component or hasMember element then either a value[x] or a data absent reason must be present.", "key": "vs-2", "severity": "error", "xpath": "f:component or f:memberOF or f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason" } ], "definition": "This profile defines how to represent Body Mass Index (BMI) observations in FHIR using a standard LOINC code and UCUM units of measure.", "id": "Observation", "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]" } ], "max": "*", "min": 0, "path": "Observation", "short": "FHIR Body Mass Index (BMI) Profile" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Observation.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Observation.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.implicitRules", "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, "max": "1", "min": 0, "path": "Observation.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Observation.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Observation.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Observation.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Observation.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Observation.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A unique identifier assigned to this observation.", "id": "Observation.identifier", "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" } ], "max": "0", "min": 0, "path": "Observation.identifier", "requirements": "Allows observations to be distinguished and referenced.", "short": "Business Identifier for observation", "type": [ { "code": "Identifier" } ] }, { "alias": [ "Fulfills" ], "base": { "max": "*", "min": 0, "path": "Observation.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.basedOn", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "ORC" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.basedOn", "requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", "short": "Fulfills plan, proposal or order", "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" ] } ] }, { "alias": [ "Container" ], "base": { "max": "*", "min": 0, "path": "Observation.partOf" }, "comment": "To link an Observation to an Encounter use `encounter`. See the [Notes](http://hl7.org/fhir/observation.html#obsgrouping) below for guidance on referencing another Observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", "id": "Observation.partOf", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "v2", "map": "Varies by domain" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target" } ], "max": "0", "min": 0, "path": "Observation.partOf", "short": "Part of referenced event", "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" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.status" }, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Status" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-status|4.0.1" }, "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status of the result value.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final" } ], "id": "Observation.status", "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, "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\"" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.status", "requirements": "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", "short": "registered | preliminary | final | amended +", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.category" }, "binding": { "description": "Codes for high level observation categories.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCategory" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the general type of observation being made.", "id": "Observation.category", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ], "max": "*", "min": 1, "mustSupport": true, "path": "Observation.category", "requirements": "Used for filtering what observations are retrieved and displayed.", "short": "Classification of type of observation", "slicing": { "discriminator": [ { "path": "coding.code", "type": "value" }, { "path": "coding.system", "type": "value" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.category" }, "binding": { "description": "Codes for high level observation categories.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCategory" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the general type of observation being made.", "id": "Observation.category:VSCat", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.category", "requirements": "Used for filtering what observations are retrieved and displayed.", "short": "Classification of type of observation", "sliceName": "VSCat", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category:VSCat.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category:VSCat.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.category:VSCat.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 1, "mustSupport": true, "path": "Observation.category.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.category:VSCat.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.category.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.category:VSCat.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.category.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "fixedUri": "http://terminology.hl7.org/CodeSystem/observation-category", "id": "Observation.category:VSCat.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.category.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.category:VSCat.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Observation.category.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "fixedCode": "vital-signs", "id": "Observation.category:VSCat.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.category.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category:VSCat.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 0, "path": "Observation.category.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.category:VSCat.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Observation.category.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.category:VSCat.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "Observation.category.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "Test", "Name" ], "base": { "max": "1", "min": 1, "path": "Observation.code" }, "binding": { "description": "This identifies the vital sign result type.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VitalSigns" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-vitalsignresult" }, "comment": "additional codes that translate or map to this code are allowed. For example a more granular LOINC code or code that is used locally in a system.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Body Mass Index (BMI).", "id": "Observation.code", "isModifier": false, "isSummary": true, "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|" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.code", "requirements": "5. SHALL contain exactly one [1..1] code, where the @code SHOULD be selected from ValueSet HITSP Vital Sign Result Type 2.16.840.1.113883.3.88.12.80.62 DYNAMIC (CONF:7301).", "short": "Body Mass Index (BMI)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 1, "path": "Observation.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "slicing": { "discriminator": [ { "path": "code", "type": "value" }, { "path": "system", "type": "value" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "Coding" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Observation.code.coding:BMICode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Observation.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "sliceName": "BMICode", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.code.coding:BMICode.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.code.coding:BMICode.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "fixedUri": "http://loinc.org", "id": "Observation.code.coding:BMICode.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.code.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Observation.code.coding:BMICode.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "1", "min": 0, "path": "Observation.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "fixedCode": "39156-5", "id": "Observation.code.coding:BMICode.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Observation.code.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.coding:BMICode.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 0, "path": "Observation.code.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Observation.code.coding:BMICode.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "1", "min": 0, "path": "Observation.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "Observation.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.subject" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.subject", "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" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.subject", "requirements": "Observations have no value if you don't know who or what they're about.", "short": "Who and/or what the observation is about", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.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](http://hl7.org/fhir/extension-observation-focuscode.html).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "id": "Observation.focus", "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" } ], "max": "0", "min": 0, "path": "Observation.focus", "short": "What the observation is about, when it is not about the subject of record", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "alias": [ "Context" ], "base": { "max": "1", "min": 0, "path": "Observation.encounter" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", "id": "Observation.encounter", "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]" } ], "max": "1", "min": 0, "path": "Observation.encounter", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "short": "Healthcare event during which this observation is made", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "alias": [ "Occurrence" ], "base": { "max": "1", "min": 0, "path": "Observation.effective[x]" }, "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](http://hl7.org/fhir/datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.", "condition": [ "vs-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "($this as dateTime).toString().length() >= 8", "human": "if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day", "key": "vs-1", "severity": "error", "xpath": "f:effectiveDateTime[matches(@value, '^\\d{4}-\\d{2}-\\d{2}')]" } ], "definition": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "id": "Observation.effective[x]", "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" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.effective[x]", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "short": "Clinically relevant time/time-period for observation [ES: Fecha asociada al registro de la observación]", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.issued" }, "comment": "For Observations that don’t require review and verification, it may be the same as the [`lastUpdated` ](http://hl7.org/fhir/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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "id": "Observation.issued", "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" } ], "max": "1", "min": 1, "path": "Observation.issued", "short": "Date/Time this version was made available [ES: Fecha asociada a la carga del dato]", "type": [ { "code": "instant" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.performer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who was responsible for asserting the observed value as \"true\".", "id": "Observation.performer", "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]" } ], "max": "*", "min": 0, "path": "Observation.performer", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "short": "Who is responsible for the observation", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.value[x]" }, "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](http://hl7.org/fhir/observation.html#notes) below.", "condition": [ "obs-7", "vs-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "id": "Observation.value[x]", "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|" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.value[x]", "requirements": "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", "short": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "slicing": { "discriminator": [ { "path": "$this", "type": "type" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.value[x]" }, "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](http://hl7.org/fhir/observation.html#notes) below.", "condition": [ "obs-7", "vs-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "id": "Observation.value[x]:valueQuantity", "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|" } ], "max": "1", "min": 1, "path": "Observation.value[x]", "requirements": "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", "short": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "sliceName": "valueQuantity", "type": [ { "code": "Quantity" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.value[x]:valueQuantity.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.value[x].id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.value[x]:valueQuantity.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.value[x].extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.value" }, "comment": "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", "id": "Observation.value[x]:valueQuantity.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "SN.2 / CQ - N/A" }, { "identity": "rim", "map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value" } ], "max": "1", "min": 1, "path": "Observation.value[x].value", "requirements": "Precision is handled implicitly in almost all cases of measurement.", "short": "Numerical value (with implicit precision)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.comparator" }, "binding": { "description": "How the Quantity should be understood and represented.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuantityComparator" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.", "id": "Observation.value[x]:valueQuantity.comparator", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value", "isSummary": true, "mapping": [ { "identity": "v2", "map": "SN.1 / CQ.1" }, { "identity": "rim", "map": "IVL properties" } ], "max": "1", "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "min": 0, "path": "Observation.value[x].comparator", "requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.", "short": "< | <= | >= | > - how to understand the value", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.unit" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable form of the unit.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Observation.value[x]:valueQuantity.unit", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ], "max": "1", "min": 1, "path": "Observation.value[x].unit", "requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.", "short": "Unit representation", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.system" }, "condition": [ "qty-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the system that provides the coded form of the unit.", "fixedUri": "http://unitsofmeasure.org", "id": "Observation.value[x]:valueQuantity.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "CO.codeSystem, PQ.translation.codeSystem" } ], "max": "1", "min": 1, "path": "Observation.value[x].system", "requirements": "Need to know the system that defines the coded form of the unit.", "short": "System that defines coded unit form", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.code" }, "comment": "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Coded responses from the common UCUM units for vital signs value set.", "fixedCode": "kg/m2", "id": "Observation.value[x]:valueQuantity.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.code, MO.currency, PQ.translation.code" } ], "max": "1", "min": 1, "path": "Observation.value[x].code", "requirements": "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.", "short": "Coded responses from the common UCUM units for vital signs value set.", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6", "vs-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "id": "Observation.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "0", "min": 0, "mustSupport": true, "path": "Observation.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "0", "min": 0, "path": "Observation.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.note" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Comments about the observation or the results.", "id": "Observation.note", "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" } ], "max": "*", "min": 0, "path": "Observation.note", "requirements": "Need to be able to provide free text additional information.", "short": "Comments about the observation", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.bodySite" }, "binding": { "description": "Codes describing anatomical locations. May include laterality.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-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](http://hl7.org/fhir/extension-bodysite.html).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the site on the subject's body where the observation was made (i.e. the target site).", "id": "Observation.bodySite", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 123037004 |Body structure|" }, { "identity": "v2", "map": "OBX-20" }, { "identity": "rim", "map": "targetSiteCode" }, { "identity": "sct-attr", "map": "718497002 |Inherent location|" } ], "max": "0", "min": 0, "path": "Observation.bodySite", "short": "Observed body part", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.method" }, "binding": { "description": "Methods for simple observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationMethod" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-methods" }, "comment": "Only used if not implicit in code for Observation.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the mechanism used to perform the observation.", "id": "Observation.method", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-17" }, { "identity": "rim", "map": "methodCode" } ], "max": "0", "min": 0, "path": "Observation.method", "requirements": "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", "short": "How it was done", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.specimen" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The specimen that was used when this observation was made.", "id": "Observation.specimen", "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|" } ], "max": "0", "min": 0, "path": "Observation.specimen", "short": "Specimen used for this observation", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.device" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The device used to generate the observation data.", "id": "Observation.device", "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|" } ], "max": "0", "min": 0, "path": "Observation.device", "short": "(Measurement) Device", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceMetric" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "low.exists() or high.exists() or text.exists()", "human": "Must have at least a low or a high or text", "key": "obs-3", "severity": "error", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))" } ], "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.", "id": "Observation.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Observation.referenceRange", "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.", "short": "Provides guide for interpretation", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.referenceRange.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.referenceRange.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.referenceRange.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.low" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.low", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.low" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.high" }, "condition": [ "obs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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).", "id": "Observation.referenceRange.high", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:IVL_PQ.high" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.type" }, "binding": { "description": "Code for the meaning of a reference range.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeMeaning" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-meaning" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", "id": "Observation.referenceRange.type", "isModifier": false, "isSummary": false, "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" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.type", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.", "short": "Reference range qualifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo" }, "binding": { "description": "Codes identifying the population the reference range applies to.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-appliesto" }, "comment": "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.appliesTo", "isModifier": false, "isSummary": false, "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" } ], "max": "*", "min": 0, "path": "Observation.referenceRange.appliesTo", "requirements": "Need to be able to identify the target population for proper interpretation.", "short": "Reference range population", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.age" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.referenceRange.age", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.age", "requirements": "Some analytes vary greatly over age.", "short": "Applicable age range, if relevant", "type": [ { "code": "Range" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.referenceRange.text" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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\".", "id": "Observation.referenceRange.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-7" }, { "identity": "rim", "map": "value:ST" } ], "max": "1", "min": 0, "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.hasMember" }, "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](http://hl7.org/fhir/observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](http://hl7.org/fhir/questionnaireresponse.html) into a final score and represent the score as an Observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Used when reporting vital signs panel components.", "id": "Observation.hasMember", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": "outBoundRelationship" } ], "max": "0", "min": 0, "path": "Observation.hasMember", "short": "Used when reporting vital signs panel components", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", "http://hl7.org/fhir/StructureDefinition/MolecularSequence", "http://hl7.org/fhir/StructureDefinition/vitalsigns" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.derivedFrom" }, "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](http://hl7.org/fhir/observation.html#obsgrouping) below.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Observation.derivedFrom", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Relationships established by OBX-4 usage" }, { "identity": "rim", "map": ".targetObservation" } ], "max": "0", "min": 0, "path": "Observation.derivedFrom", "short": "Related measurements the observation is made from", "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/MolecularSequence", "http://hl7.org/fhir/StructureDefinition/vitalsigns" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component" }, "comment": "For a discussion on the ways Observations can be assembled in groups together see [Notes](http://hl7.org/fhir/observation.html#notes) below.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "value.exists() or dataAbsentReason.exists()", "human": "If there is no a value a data absent reason must be present", "key": "vs-3", "severity": "error", "xpath": "f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason" } ], "definition": "Used when reporting systolic and diastolic blood pressure.", "id": "Observation.component", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "containment by OBX-4?" }, { "identity": "rim", "map": "outBoundRelationship[typeCode=COMP]" } ], "max": "0", "min": 0, "mustSupport": true, "path": "Observation.component", "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.", "short": "Used when reporting systolic and diastolic blood pressure.", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Observation.component.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Observation.component.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Observation.component.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Observation.component.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Observation.component.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Observation.component.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Observation.component.code" }, "binding": { "description": "This identifies the vital sign result type.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VitalSigns" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-vitalsignresult" }, "comment": "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "id": "Observation.component.code", "isModifier": false, "isSummary": true, "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" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Observation.component.code", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "short": "Type of component observation (code / type)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.value[x]" }, "binding": { "description": "Common UCUM units for recording Vital Signs.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VitalSignsUnits" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1" }, "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](http://hl7.org/fhir/observation.html#notes) below.", "condition": [ "vs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Vital Sign Value recorded with UCUM.", "id": "Observation.component.value[x]", "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|" } ], "max": "1", "min": 0, "mustSupport": true, "path": "Observation.component.value[x]", "requirements": "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", "short": "Vital Sign Value recorded with UCUM", "type": [ { "code": "Quantity" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "time" }, { "code": "dateTime" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Observation.component.dataAbsentReason" }, "binding": { "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason" }, "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.", "condition": [ "obs-6", "vs-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", "id": "Observation.component.dataAbsentReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "value.nullFlavor" } ], "max": "1", "min": 0, "mustSupport": true, "path": "Observation.component.dataAbsentReason", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "short": "Why the component result is missing", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "Abnormal Flag" ], "base": { "max": "*", "min": 0, "path": "Observation.component.interpretation" }, "binding": { "description": "Codes identifying interpretations of observations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorical assessment of an observation value. For example, high, low, normal.", "id": "Observation.component.interpretation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 260245000 |Findings values|" }, { "identity": "v2", "map": "OBX-8" }, { "identity": "rim", "map": "interpretationCode" }, { "identity": "sct-attr", "map": "363713009 |Has interpretation|" } ], "max": "*", "min": 0, "path": "Observation.component.interpretation", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "short": "High, low, normal, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Observation.component.referenceRange" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Observation.referenceRange", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.", "id": "Observation.component.referenceRange", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX.7" }, { "identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]" } ], "max": "*", "min": 0, "path": "Observation.component.referenceRange", "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.", "short": "Provides guide for interpretation of component result" } ] }, "status": "draft", "title": "OneHealth ObsBMI", "type": "Observation", "url": "https://fhir.onehealth.com.pe/StructureDefinition/ObsBMIOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/MedicationRequestOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MedicationRequest", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR MedicationRequestOH, for OH interoperability scenarios, based on the national CORE MedicationRequest Profile defined by HL7 OH.", "differential": { "element": [ { "id": "MedicationRequest.identifier", "max": "1", "min": 1, "path": "MedicationRequest.identifier", "short": "Valor por defecto 'order'" }, { "id": "MedicationRequest.identifier.use", "max": "0", "path": "MedicationRequest.identifier.use" }, { "id": "MedicationRequest.identifier.type", "max": "0", "path": "MedicationRequest.identifier.type" }, { "id": "MedicationRequest.identifier.system", "min": 1, "path": "MedicationRequest.identifier.system" }, { "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: identificador del item dentro de la orden de medicamentos. Ejemplo: XXXXX-1]", "id": "MedicationRequest.identifier.value", "min": 1, "path": "MedicationRequest.identifier.value", "short": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: identificador del item dentro de la orden de medicamentos. Ejemplo: XXXXX-1]" }, { "id": "MedicationRequest.identifier.period", "max": "0", "path": "MedicationRequest.identifier.period" }, { "id": "MedicationRequest.identifier.assigner", "min": 1, "path": "MedicationRequest.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "definition": "A code specifying the current state of the order. Generally, this will be active or completed state. [ES: Ej: Cuando el profesional crea la orden: \"active\".]", "id": "MedicationRequest.status", "path": "MedicationRequest.status", "short": "A code specifying the current state of the order. Generally, this will be active or completed state. [ES: Ej: Cuando el profesional crea la orden: \"active\".]" }, { "id": "MedicationRequest.statusReason", "max": "0", "path": "MedicationRequest.statusReason" }, { "definition": "Whether the request is a proposal, plan, or an original order. [ES: Valor por defecto \"order\"]", "id": "MedicationRequest.intent", "path": "MedicationRequest.intent", "patternCode": "order", "short": "Whether the request is a proposal, plan, or an original order. [ES: Valor por defecto \"order\"]" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/medicationrequest-category" }, "id": "MedicationRequest.category", "max": "1", "path": "MedicationRequest.category" }, { "id": "MedicationRequest.category.coding.system", "min": 1, "path": "MedicationRequest.category.coding.system" }, { "id": "MedicationRequest.category.coding.version", "max": "0", "path": "MedicationRequest.category.coding.version" }, { "id": "MedicationRequest.category.coding.code", "min": 1, "path": "MedicationRequest.category.coding.code", "short": "Symbol in syntax defined by the system. [ES: Ej: Para el ámbito ambulatorio: \"outpatient\"]" }, { "id": "MedicationRequest.category.coding.display", "min": 1, "path": "MedicationRequest.category.coding.display" }, { "id": "MedicationRequest.category.coding.userSelected", "max": "0", "path": "MedicationRequest.category.coding.userSelected" }, { "id": "MedicationRequest.category.text", "max": "0", "path": "MedicationRequest.category.text" }, { "id": "MedicationRequest.doNotPerform", "max": "0", "path": "MedicationRequest.doNotPerform" }, { "id": "MedicationRequest.reported[x]", "max": "0", "path": "MedicationRequest.reported[x]" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/medication-codes" }, "id": "MedicationRequest.medication[x]", "path": "MedicationRequest.medication[x]", "type": [ { "code": "CodeableConcept" } ] }, { "id": "MedicationRequest.medication[x].coding.system", "min": 1, "path": "MedicationRequest.medication[x].coding.system" }, { "id": "MedicationRequest.medication[x].coding.version", "max": "0", "path": "MedicationRequest.medication[x].coding.version" }, { "id": "MedicationRequest.medication[x].coding.code", "min": 1, "path": "MedicationRequest.medication[x].coding.code" }, { "id": "MedicationRequest.medication[x].coding.display", "min": 1, "path": "MedicationRequest.medication[x].coding.display" }, { "id": "MedicationRequest.medication[x].coding.userSelected", "max": "0", "path": "MedicationRequest.medication[x].coding.userSelected" }, { "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. [ES: se utiliza cuando el medicamento no está codificado]", "id": "MedicationRequest.medication[x].text", "path": "MedicationRequest.medication[x].text", "short": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. [ES: se utiliza cuando el medicamento no está codificado]" }, { "id": "MedicationRequest.subject", "path": "MedicationRequest.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "MedicationRequest.encounter", "path": "MedicationRequest.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "id": "MedicationRequest.supportingInformation", "max": "0", "path": "MedicationRequest.supportingInformation" }, { "id": "MedicationRequest.requester", "path": "MedicationRequest.requester", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "MedicationRequest.performer", "max": "0", "path": "MedicationRequest.performer" }, { "id": "MedicationRequest.performerType", "max": "0", "path": "MedicationRequest.performerType" }, { "id": "MedicationRequest.recorder", "max": "0", "path": "MedicationRequest.recorder" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-code" }, "id": "MedicationRequest.reasonCode", "max": "1", "path": "MedicationRequest.reasonCode" }, { "id": "MedicationRequest.reasonCode.coding.system", "min": 1, "path": "MedicationRequest.reasonCode.coding.system" }, { "id": "MedicationRequest.reasonCode.coding.version", "max": "0", "path": "MedicationRequest.reasonCode.coding.version" }, { "id": "MedicationRequest.reasonCode.coding.code", "min": 1, "path": "MedicationRequest.reasonCode.coding.code" }, { "id": "MedicationRequest.reasonCode.coding.display", "min": 1, "path": "MedicationRequest.reasonCode.coding.display" }, { "id": "MedicationRequest.reasonCode.coding.userSelected", "max": "0", "path": "MedicationRequest.reasonCode.coding.userSelected" }, { "id": "MedicationRequest.reasonCode.text", "max": "0", "path": "MedicationRequest.reasonCode.text" }, { "id": "MedicationRequest.reasonReference", "path": "MedicationRequest.reasonReference", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH", "https://fhir.onehealth.com.pe/StructureDefinition/ConditionProblemListItemOH" ] } ] }, { "id": "MedicationRequest.instantiatesCanonical", "max": "0", "path": "MedicationRequest.instantiatesCanonical" }, { "id": "MedicationRequest.instantiatesUri", "max": "0", "path": "MedicationRequest.instantiatesUri" }, { "id": "MedicationRequest.basedOn", "max": "0", "path": "MedicationRequest.basedOn" }, { "id": "MedicationRequest.groupIdentifier", "min": 1, "path": "MedicationRequest.groupIdentifier", "short": "Composite request this is part of.\r\n[ES: Identificador de la receta]" }, { "definition": "The purpose of this identifier. [ES: Valor por defecto \"official\"]", "id": "MedicationRequest.groupIdentifier.use", "min": 1, "path": "MedicationRequest.groupIdentifier.use", "patternCode": "official", "short": "The purpose of this identifier. [ES: Valor por defecto \"official\"]" }, { "id": "MedicationRequest.groupIdentifier.type", "max": "0", "path": "MedicationRequest.groupIdentifier.type" }, { "id": "MedicationRequest.groupIdentifier.system", "min": 1, "path": "MedicationRequest.groupIdentifier.system" }, { "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: Número de orden de medicamentos o número de receta]", "id": "MedicationRequest.groupIdentifier.value", "min": 1, "path": "MedicationRequest.groupIdentifier.value", "short": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: Número de orden de medicamentos o número de receta]" }, { "id": "MedicationRequest.groupIdentifier.period", "max": "0", "path": "MedicationRequest.groupIdentifier.period" }, { "id": "MedicationRequest.groupIdentifier.assigner", "min": 1, "path": "MedicationRequest.groupIdentifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy" }, "id": "MedicationRequest.courseOfTherapyType", "path": "MedicationRequest.courseOfTherapyType" }, { "id": "MedicationRequest.courseOfTherapyType.coding.system", "min": 1, "path": "MedicationRequest.courseOfTherapyType.coding.system" }, { "id": "MedicationRequest.courseOfTherapyType.coding.version", "max": "0", "path": "MedicationRequest.courseOfTherapyType.coding.version" }, { "id": "MedicationRequest.courseOfTherapyType.coding.code", "min": 1, "path": "MedicationRequest.courseOfTherapyType.coding.code" }, { "id": "MedicationRequest.courseOfTherapyType.coding.display", "min": 1, "path": "MedicationRequest.courseOfTherapyType.coding.display" }, { "id": "MedicationRequest.courseOfTherapyType.coding.userSelected", "max": "0", "path": "MedicationRequest.courseOfTherapyType.coding.userSelected" }, { "id": "MedicationRequest.courseOfTherapyType.text", "max": "0", "path": "MedicationRequest.courseOfTherapyType.text" }, { "id": "MedicationRequest.insurance", "max": "0", "path": "MedicationRequest.insurance" }, { "id": "MedicationRequest.dosageInstruction", "max": "1", "min": 1, "path": "MedicationRequest.dosageInstruction" }, { "id": "MedicationRequest.dosageInstruction.sequence", "max": "0", "path": "MedicationRequest.dosageInstruction.sequence" }, { "definition": "Free text dosage instructions e.g. SIG. [ES: Instrucciones de dosificación de texto libre, por ejemplo, \"ACETAMINOFEN 500MG CAX100 TA, Dosis: 500mg, Vía: oral, Frecuencia: 6 horas, Días: 3\"]", "id": "MedicationRequest.dosageInstruction.text", "min": 1, "path": "MedicationRequest.dosageInstruction.text", "short": "Free text dosage instructions e.g. SIG. [ES: Instrucciones de dosificación de texto libre, por ejemplo, \"ACETAMINOFEN 500MG CAX100 TA, Dosis: 500mg, Vía: oral, Frecuencia: 6 horas, Días: 3\"]" }, { "id": "MedicationRequest.dosageInstruction.additionalInstruction", "max": "0", "path": "MedicationRequest.dosageInstruction.additionalInstruction" }, { "definition": "When medication should be administered. [ES: Cuándo se debe administrar la medicación]", "id": "MedicationRequest.dosageInstruction.timing", "path": "MedicationRequest.dosageInstruction.timing", "short": "When medication should be administered. [ES: Cuándo se debe administrar la medicación]" }, { "id": "MedicationRequest.dosageInstruction.timing.repeat.frequencyMax", "max": "0", "path": "MedicationRequest.dosageInstruction.timing.repeat.frequencyMax" }, { "id": "MedicationRequest.dosageInstruction.timing.repeat.periodMax", "max": "0", "path": "MedicationRequest.dosageInstruction.timing.repeat.periodMax" }, { "id": "MedicationRequest.dosageInstruction.timing.repeat.dayOfWeek", "max": "0", "path": "MedicationRequest.dosageInstruction.timing.repeat.dayOfWeek" }, { "id": "MedicationRequest.dosageInstruction.timing.repeat.timeOfDay", "max": "0", "path": "MedicationRequest.dosageInstruction.timing.repeat.timeOfDay" }, { "id": "MedicationRequest.dosageInstruction.timing.repeat.when", "max": "0", "path": "MedicationRequest.dosageInstruction.timing.repeat.when" }, { "id": "MedicationRequest.dosageInstruction.timing.repeat.offset", "max": "0", "path": "MedicationRequest.dosageInstruction.timing.repeat.offset" }, { "id": "MedicationRequest.dosageInstruction.timing.code", "max": "0", "path": "MedicationRequest.dosageInstruction.timing.code" }, { "id": "MedicationRequest.dosageInstruction.asNeeded[x]", "max": "0", "path": "MedicationRequest.dosageInstruction.asNeeded[x]" }, { "id": "MedicationRequest.dosageInstruction.site", "max": "0", "path": "MedicationRequest.dosageInstruction.site" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/route-codes" }, "id": "MedicationRequest.dosageInstruction.route", "path": "MedicationRequest.dosageInstruction.route" }, { "id": "MedicationRequest.dosageInstruction.route.coding.system", "min": 1, "path": "MedicationRequest.dosageInstruction.route.coding.system" }, { "id": "MedicationRequest.dosageInstruction.route.coding.version", "max": "0", "path": "MedicationRequest.dosageInstruction.route.coding.version" }, { "id": "MedicationRequest.dosageInstruction.route.coding.code", "min": 1, "path": "MedicationRequest.dosageInstruction.route.coding.code" }, { "id": "MedicationRequest.dosageInstruction.route.coding.display", "min": 1, "path": "MedicationRequest.dosageInstruction.route.coding.display" }, { "id": "MedicationRequest.dosageInstruction.route.coding.userSelected", "max": "0", "path": "MedicationRequest.dosageInstruction.route.coding.userSelected" }, { "id": "MedicationRequest.dosageInstruction.route.text", "max": "0", "path": "MedicationRequest.dosageInstruction.route.text" }, { "id": "MedicationRequest.dosageInstruction.method", "max": "0", "path": "MedicationRequest.dosageInstruction.method" }, { "id": "MedicationRequest.dosageInstruction.doseAndRate", "max": "1", "path": "MedicationRequest.dosageInstruction.doseAndRate" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/dose-rate-type" }, "id": "MedicationRequest.dosageInstruction.doseAndRate.type", "path": "MedicationRequest.dosageInstruction.doseAndRate.type" }, { "id": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.system", "min": 1, "path": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.system" }, { "id": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.version", "max": "0", "path": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.version" }, { "id": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.code", "min": 1, "path": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.code" }, { "id": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.display", "min": 1, "path": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.display" }, { "id": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.userSelected", "max": "0", "path": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.userSelected" }, { "id": "MedicationRequest.dosageInstruction.doseAndRate.type.text", "max": "0", "path": "MedicationRequest.dosageInstruction.doseAndRate.type.text" }, { "id": "MedicationRequest.dosageInstruction.doseAndRate.dose[x]", "path": "MedicationRequest.dosageInstruction.doseAndRate.dose[x]", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "id": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].value", "min": 1, "path": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].value" }, { "id": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].unit", "min": 1, "path": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].unit" }, { "id": "MedicationRequest.dosageInstruction.maxDosePerPeriod", "max": "0", "path": "MedicationRequest.dosageInstruction.maxDosePerPeriod" }, { "id": "MedicationRequest.dosageInstruction.maxDosePerAdministration", "max": "0", "path": "MedicationRequest.dosageInstruction.maxDosePerAdministration" }, { "id": "MedicationRequest.dosageInstruction.maxDosePerLifetime", "max": "0", "path": "MedicationRequest.dosageInstruction.maxDosePerLifetime" }, { "id": "MedicationRequest.dispenseRequest", "max": "0", "path": "MedicationRequest.dispenseRequest" }, { "id": "MedicationRequest.substitution", "max": "0", "path": "MedicationRequest.substitution" }, { "id": "MedicationRequest.priorPrescription", "max": "0", "path": "MedicationRequest.priorPrescription" }, { "id": "MedicationRequest.detectedIssue", "max": "0", "path": "MedicationRequest.detectedIssue" }, { "id": "MedicationRequest.eventHistory", "max": "0", "path": "MedicationRequest.eventHistory" } ] }, "fhirVersion": "4.0.1", "id": "MedicationRequestOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "script10.6", "name": "Mapping to NCPDP SCRIPT 10.6", "uri": "http://ncpdp.org/SCRIPT10_6" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" } ], "meta": { "lastUpdated": "2024-04-12T17:46:22.783512+00:00", "versionId": "MTcxMjk0Mzk4Mjc4MzUxMjAwMA" }, "name": "MedicationRequestOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Prescription", "Order" ], "base": { "max": "*", "min": 0, "path": "MedicationRequest" }, "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "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.", "id": "MedicationRequest", "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" } ], "max": "*", "min": 0, "path": "MedicationRequest", "short": "Ordering of medication for patient or group" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "MedicationRequest.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "MedicationRequest.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "MedicationRequest.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "MedicationRequest.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "MedicationRequest.implicitRules", "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, "max": "1", "min": 0, "path": "MedicationRequest.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "MedicationRequest.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "MedicationRequest.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "MedicationRequest.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "MedicationRequest.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "MedicationRequest.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "MedicationRequest.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "MedicationRequest.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "MedicationRequest.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "MedicationRequest.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "MedicationRequest.identifier" }, "comment": "This is a business identifier, not a resource identifier.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "MedicationRequest.identifier", "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" } ], "max": "1", "min": 1, "path": "MedicationRequest.identifier", "short": "Valor por defecto 'order'", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "MedicationRequest.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "MedicationRequest.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "MedicationRequest.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "MedicationRequest.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "MedicationRequest.identifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 1, "path": "MedicationRequest.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: identificador del item dentro de la orden de medicamentos. Ejemplo: XXXXX-1]", "example": [ { "label": "General", "valueString": "123456" } ], "id": "MedicationRequest.identifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "MedicationRequest.identifier.value", "short": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: identificador del item dentro de la orden de medicamentos. Ejemplo: XXXXX-1]", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "MedicationRequest.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "MedicationRequest.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "MedicationRequest.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 1, "path": "MedicationRequest.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 1, "path": "MedicationRequest.status" }, "binding": { "description": "A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationRequestStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1" }, "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code specifying the current state of the order. Generally, this will be active or completed state. [ES: Ej: Cuando el profesional crea la orden: \"active\".]", "id": "MedicationRequest.status", "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, "mapping": [ { "identity": "workflow", "map": "Request.status" }, { "identity": "script10.6", "map": "no mapping" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": ".statusCode" } ], "max": "1", "min": 1, "path": "MedicationRequest.status", "short": "A code specifying the current state of the order. Generally, this will be active or completed state. [ES: Ej: Cuando el profesional crea la orden: \"active\".]", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.statusReason" }, "binding": { "description": "Identifies the reasons for a given status.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationRequestStatusReason" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Captures the reason for the current state of the MedicationRequest.", "id": "MedicationRequest.statusReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.statusReason" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde" } ], "max": "0", "min": 0, "path": "MedicationRequest.statusReason", "short": "Reason for current status", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 1, "path": "MedicationRequest.intent" }, "binding": { "description": "The kind of medication order.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationRequestIntent" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Whether the request is a proposal, plan, or an original order. [ES: Valor por defecto \"order\"]", "id": "MedicationRequest.intent", "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, "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)" } ], "max": "1", "min": 1, "path": "MedicationRequest.intent", "patternCode": "order", "short": "Whether the request is a proposal, plan, or an original order. [ES: Valor por defecto \"order\"]", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "MedicationRequest.category" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/medicationrequest-category" }, "comment": "The category can be used to include where the medication is expected to be consumed or other types of requests.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).", "id": "MedicationRequest.category", "isModifier": false, "isSummary": false, "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" } ], "max": "1", "min": 0, "path": "MedicationRequest.category", "short": "Type of medication usage", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.category.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.category.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.category.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.category.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "MedicationRequest.category.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "MedicationRequest.category.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.category.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.category.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.category.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.category.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "MedicationRequest.category.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "MedicationRequest.category.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "MedicationRequest.category.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "MedicationRequest.category.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "MedicationRequest.category.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "MedicationRequest.category.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system. [ES: Ej: Para el ámbito ambulatorio: \"outpatient\"]", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "MedicationRequest.category.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "MedicationRequest.category.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "MedicationRequest.category.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "MedicationRequest.category.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "MedicationRequest.category.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "MedicationRequest.category.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.priority" }, "binding": { "description": "Identifies the level of importance to be assigned to actioning the request.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationRequestPriority" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-priority|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates how quickly the Medication Request should be addressed with respect to other requests.", "id": "MedicationRequest.priority", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.priority" }, { "identity": "w5", "map": "FiveWs.grade" }, { "identity": "rim", "map": ".priorityCode" } ], "max": "1", "min": 0, "path": "MedicationRequest.priority", "short": "routine | urgent | asap | stat", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.doNotPerform" }, "comment": "If do not perform is not specified, the request is a positive request e.g. \"do perform\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If true indicates that the provider is asking for the medication request not to occur.", "id": "MedicationRequest.doNotPerform", "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" } ], "max": "0", "min": 0, "path": "MedicationRequest.doNotPerform", "short": "True if request is prohibiting action", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.reported[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "MedicationRequest.reported[x]", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=INF].role" } ], "max": "0", "min": 0, "path": "MedicationRequest.reported[x]", "short": "Reported rather than primary record", "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" ] } ] }, { "base": { "max": "1", "min": 1, "path": "MedicationRequest.medication[x]" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/medication-codes" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "MedicationRequest.medication[x]", "isModifier": false, "isSummary": true, "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" } ], "max": "1", "min": 1, "path": "MedicationRequest.medication[x]", "short": "Medication to be taken", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.medication[x].id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.medication[x].id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.medication[x].extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.medication[x].extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "MedicationRequest.medication[x].coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "MedicationRequest.medication[x].coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.medication[x].coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.medication[x].coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.medication[x].coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.medication[x].coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "MedicationRequest.medication[x].coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "MedicationRequest.medication[x].coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "MedicationRequest.medication[x].coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "MedicationRequest.medication[x].coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "MedicationRequest.medication[x].coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "MedicationRequest.medication[x].coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "MedicationRequest.medication[x].coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "MedicationRequest.medication[x].coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "MedicationRequest.medication[x].coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "MedicationRequest.medication[x].coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. [ES: se utiliza cuando el medicamento no está codificado]", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "MedicationRequest.medication[x].text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "MedicationRequest.medication[x].text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. [ES: se utiliza cuando el medicamento no está codificado]", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 1, "path": "MedicationRequest.subject" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A link to a resource representing the person or set of individuals to whom the medication will be given.", "id": "MedicationRequest.subject", "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" } ], "max": "1", "min": 1, "path": "MedicationRequest.subject", "short": "Who or group medication request is for", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.encounter" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Encounter during which this [x] was created or to which the creation of this record is tightly associated.", "id": "MedicationRequest.encounter", "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\"]" } ], "max": "1", "min": 0, "path": "MedicationRequest.encounter", "short": "Encounter created as part of encounter/admission/stay", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "MedicationRequest.supportingInformation" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Include additional information (for example, patient height and weight) that supports the ordering of the medication.", "id": "MedicationRequest.supportingInformation", "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)]" } ], "max": "0", "min": 0, "path": "MedicationRequest.supportingInformation", "short": "Information to support ordering of the medication", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.authoredOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date (and perhaps time) when the prescription was initially written or authored on.", "id": "MedicationRequest.authoredOn", "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" } ], "max": "1", "min": 0, "path": "MedicationRequest.authoredOn", "short": "When request was initially authored", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.requester" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The individual, organization, or device that initiated the request and has responsibility for its activation.", "id": "MedicationRequest.requester", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.requester" }, { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" } ], "max": "1", "min": 0, "path": "MedicationRequest.requester", "short": "Who/What requested the Request", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.performer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The specified desired performer of the medication treatment (e.g. the performer of the medication administration).", "id": "MedicationRequest.performer", "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]" } ], "max": "0", "min": 0, "path": "MedicationRequest.performer", "short": "Intended performer of administration", "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" ] } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.performerType" }, "binding": { "description": "Identifies the type of individual that is desired to administer the medication.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationRequestPerformerType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/performer-role" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the type of performer of the administration of the medication.", "id": "MedicationRequest.performerType", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.performerType" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code" } ], "max": "0", "min": 0, "path": "MedicationRequest.performerType", "short": "Desired kind of performer of the medication administration", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.recorder" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.", "id": "MedicationRequest.recorder", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.who" }, { "identity": "rim", "map": ".participation[typeCode=TRANS].role[classCode=ASSIGNED].code (HealthcareProviderType)" } ], "max": "0", "min": 0, "path": "MedicationRequest.recorder", "short": "Person who entered the request", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ] } ] }, { "base": { "max": "*", "min": 0, "path": "MedicationRequest.reasonCode" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-code" }, "comment": "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The reason or the indication for ordering or not ordering the medication.", "id": "MedicationRequest.reasonCode", "isModifier": false, "isSummary": false, "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" } ], "max": "1", "min": 0, "path": "MedicationRequest.reasonCode", "short": "Reason or indication for ordering or not ordering the medication", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.reasonCode.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.reasonCode.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.reasonCode.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.reasonCode.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "MedicationRequest.reasonCode.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "MedicationRequest.reasonCode.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.reasonCode.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.reasonCode.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.reasonCode.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.reasonCode.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "MedicationRequest.reasonCode.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "MedicationRequest.reasonCode.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "MedicationRequest.reasonCode.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "MedicationRequest.reasonCode.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "MedicationRequest.reasonCode.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "MedicationRequest.reasonCode.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "MedicationRequest.reasonCode.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "MedicationRequest.reasonCode.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "MedicationRequest.reasonCode.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "MedicationRequest.reasonCode.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "MedicationRequest.reasonCode.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "MedicationRequest.reasonCode.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "MedicationRequest.reasonReference" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Condition or observation that supports why the medication was ordered.", "id": "MedicationRequest.reasonReference", "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" } ], "max": "*", "min": 0, "path": "MedicationRequest.reasonReference", "short": "Condition or observation that supports why the prescription is being written", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH", "https://fhir.onehealth.com.pe/StructureDefinition/ConditionProblemListItemOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "MedicationRequest.instantiatesCanonical" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.", "id": "MedicationRequest.instantiatesCanonical", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.instantiates" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ], "max": "0", "min": 0, "path": "MedicationRequest.instantiatesCanonical", "short": "Instantiates FHIR protocol or definition", "type": [ { "code": "canonical" } ] }, { "base": { "max": "*", "min": 0, "path": "MedicationRequest.instantiatesUri" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "MedicationRequest.instantiatesUri", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ], "max": "0", "min": 0, "path": "MedicationRequest.instantiatesUri", "short": "Instantiates external protocol or definition", "type": [ { "code": "uri" } ] }, { "base": { "max": "*", "min": 0, "path": "MedicationRequest.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A plan or request that is fulfilled in whole or in part by this medication request.", "id": "MedicationRequest.basedOn", "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]" } ], "max": "0", "min": 0, "path": "MedicationRequest.basedOn", "short": "What request fulfills", "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" ] } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.groupIdentifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "MedicationRequest.groupIdentifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.groupIdentifier" }, { "identity": "rim", "map": ".outboundRelationship(typeCode=COMP].target[classCode=SBADM, moodCode=INT].id" } ], "max": "1", "min": 1, "path": "MedicationRequest.groupIdentifier", "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.", "short": "Composite request this is part of.\r\n[ES: Identificador de la receta]", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.groupIdentifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.groupIdentifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.groupIdentifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.groupIdentifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier. [ES: Valor por defecto \"official\"]", "id": "MedicationRequest.groupIdentifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "MedicationRequest.groupIdentifier.use", "patternCode": "official", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "The purpose of this identifier. [ES: Valor por defecto \"official\"]", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "MedicationRequest.groupIdentifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "MedicationRequest.groupIdentifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "MedicationRequest.groupIdentifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 1, "path": "MedicationRequest.groupIdentifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: Número de orden de medicamentos o número de receta]", "example": [ { "label": "General", "valueString": "123456" } ], "id": "MedicationRequest.groupIdentifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "MedicationRequest.groupIdentifier.value", "short": "The portion of the identifier typically relevant to the user and which is unique within the context of the system. [ES: Número de orden de medicamentos o número de receta]", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "MedicationRequest.groupIdentifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "MedicationRequest.groupIdentifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "MedicationRequest.groupIdentifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 1, "path": "MedicationRequest.groupIdentifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.courseOfTherapyType" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy" }, "comment": "This attribute should not be confused with the protocol of the medication.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The description of the overall patte3rn of the administration of the medication to the patient.", "id": "MedicationRequest.courseOfTherapyType", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.code where classCode = LIST and moodCode = EVN" } ], "max": "1", "min": 0, "path": "MedicationRequest.courseOfTherapyType", "short": "Overall pattern of medication administration", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.courseOfTherapyType.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.courseOfTherapyType.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.courseOfTherapyType.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.courseOfTherapyType.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "MedicationRequest.courseOfTherapyType.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "MedicationRequest.courseOfTherapyType.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.courseOfTherapyType.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.courseOfTherapyType.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.courseOfTherapyType.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.courseOfTherapyType.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "MedicationRequest.courseOfTherapyType.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "MedicationRequest.courseOfTherapyType.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "MedicationRequest.courseOfTherapyType.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "MedicationRequest.courseOfTherapyType.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "MedicationRequest.courseOfTherapyType.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "MedicationRequest.courseOfTherapyType.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "MedicationRequest.courseOfTherapyType.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "MedicationRequest.courseOfTherapyType.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "MedicationRequest.courseOfTherapyType.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "MedicationRequest.courseOfTherapyType.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "MedicationRequest.courseOfTherapyType.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "MedicationRequest.courseOfTherapyType.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "MedicationRequest.insurance" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.", "id": "MedicationRequest.insurance", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.insurance" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COVBY].target" } ], "max": "0", "min": 0, "path": "MedicationRequest.insurance", "short": "Associated insurance coverage", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Coverage", "http://hl7.org/fhir/StructureDefinition/ClaimResponse" ] } ] }, { "base": { "max": "*", "min": 0, "path": "MedicationRequest.note" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Extra information about the prescription that could not be conveyed by the other attributes.", "id": "MedicationRequest.note", "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" } ], "max": "*", "min": 0, "path": "MedicationRequest.note", "short": "Information about the prescription", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates how the medication is to be used by the patient.", "id": "MedicationRequest.dosageInstruction", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.occurrence[x]" }, { "identity": "rim", "map": "see dosageInstruction mapping" } ], "max": "1", "min": 1, "path": "MedicationRequest.dosageInstruction", "short": "How the medication should be taken", "type": [ { "code": "Dosage" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.dosageInstruction.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.dosageInstruction.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "MedicationRequest.dosageInstruction.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Dosage.sequence" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the order in which the dosage instructions should be applied or interpreted.", "id": "MedicationRequest.dosageInstruction.sequence", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "TQ1-1" }, { "identity": "rim", "map": ".text" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.sequence", "requirements": "If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential.", "short": "The order of the dosage instructions", "type": [ { "code": "integer" } ] }, { "base": { "max": "1", "min": 0, "path": "Dosage.text" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Free text dosage instructions e.g. SIG. [ES: Instrucciones de dosificación de texto libre, por ejemplo, \"ACETAMINOFEN 500MG CAX100 TA, Dosis: 500mg, Vía: oral, Frecuencia: 6 horas, Días: 3\"]", "id": "MedicationRequest.dosageInstruction.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXO-6; RXE-21" }, { "identity": "rim", "map": ".text" } ], "max": "1", "min": 1, "path": "MedicationRequest.dosageInstruction.text", "requirements": "Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text.", "short": "Free text dosage instructions e.g. SIG. [ES: Instrucciones de dosificación de texto libre, por ejemplo, \"ACETAMINOFEN 500MG CAX100 TA, Dosis: 500mg, Vía: oral, Frecuencia: 6 horas, Días: 3\"]", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Dosage.additionalInstruction" }, "binding": { "description": "A coded concept identifying additional instructions such as \"take with water\" or \"avoid operating heavy machinery\".", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdditionalInstruction" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/additional-instruction-codes" }, "comment": "Information about administration or preparation of the medication (e.g. \"infuse as rapidly as possibly via intraperitoneal port\" or \"immediately following drug x\") should be populated in dosage.text.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Supplemental instructions to the patient on how to take the medication (e.g. \"with meals\" or\"take half to one hour before food\") or warnings for the patient about the medication (e.g. \"may cause drowsiness\" or \"avoid exposure of skin to direct sunlight or sunlamps\").", "id": "MedicationRequest.dosageInstruction.additionalInstruction", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXO-7" }, { "identity": "rim", "map": ".text" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.additionalInstruction", "requirements": "Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, \"Swallow with plenty of water\" which might or might not be coded.", "short": "Supplemental instruction or warnings to the patient - e.g. \"with meals\", \"may cause drowsiness\"", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Dosage.patientInstruction" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instructions in terms that are understood by the patient or consumer.", "id": "MedicationRequest.dosageInstruction.patientInstruction", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXO-7" }, { "identity": "rim", "map": ".text" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.patientInstruction", "short": "Patient or consumer oriented instructions", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Dosage.timing" }, "comment": "This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When medication should be administered. [ES: Cuándo se debe administrar la medicación]", "id": "MedicationRequest.dosageInstruction.timing", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.timing", "requirements": "The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.", "short": "When medication should be administered. [ES: Cuándo se debe administrar la medicación]", "type": [ { "code": "Timing" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.dosageInstruction.timing.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.dosageInstruction.timing.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "MedicationRequest.dosageInstruction.timing.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Timing.event" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies specific times when the event occurs.", "id": "MedicationRequest.dosageInstruction.timing.event", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "QLIST<TS>" } ], "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.event", "requirements": "In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.", "short": "When the event occurs", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Timing.repeat" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "duration.empty() or durationUnit.exists()", "human": "if there's a duration, there needs to be duration units", "key": "tim-1", "severity": "error", "xpath": "not(exists(f:duration)) or exists(f:durationUnit)" }, { "expression": "period.empty() or periodUnit.exists()", "human": "if there's a period, there needs to be period units", "key": "tim-2", "severity": "error", "xpath": "not(exists(f:period)) or exists(f:periodUnit)" }, { "expression": "duration.exists() implies duration >= 0", "human": "duration SHALL be a non-negative value", "key": "tim-4", "severity": "error", "xpath": "f:duration/@value >= 0 or not(f:duration/@value)" }, { "expression": "period.exists() implies period >= 0", "human": "period SHALL be a non-negative value", "key": "tim-5", "severity": "error", "xpath": "f:period/@value >= 0 or not(f:period/@value)" }, { "expression": "periodMax.empty() or period.exists()", "human": "If there's a periodMax, there must be a period", "key": "tim-6", "severity": "error", "xpath": "not(exists(f:periodMax)) or exists(f:period)" }, { "expression": "durationMax.empty() or duration.exists()", "human": "If there's a durationMax, there must be a duration", "key": "tim-7", "severity": "error", "xpath": "not(exists(f:durationMax)) or exists(f:duration)" }, { "expression": "countMax.empty() or count.exists()", "human": "If there's a countMax, there must be a count", "key": "tim-8", "severity": "error", "xpath": "not(exists(f:countMax)) or exists(f:count)" }, { "expression": "offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))", "human": "If there's an offset, there must be a when (and not C, CM, CD, CV)", "key": "tim-9", "severity": "error", "xpath": "not(exists(f:offset)) or exists(f:when)" }, { "expression": "timeOfDay.empty() or when.empty()", "human": "If there's a timeOfDay, there cannot be a when, or vice versa", "key": "tim-10", "severity": "error", "xpath": "not(exists(f:timeOfDay)) or not(exists(f:when))" } ], "definition": "A set of rules that describe when the event is scheduled.", "id": "MedicationRequest.dosageInstruction.timing.repeat", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "Implies PIVL or EIVL" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat", "requirements": "Many timing schedules are determined by regular repetitions.", "short": "When the event is to occur", "type": [ { "code": "Element" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.dosageInstruction.timing.repeat.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.dosageInstruction.timing.repeat.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Timing.repeat.bounds[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.", "id": "MedicationRequest.dosageInstruction.timing.repeat.bounds[x]", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "IVL(TS) used in a QSI" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.bounds[x]", "short": "Length/Range of lengths, or (Start and/or end) limits", "type": [ { "code": "Duration" }, { "code": "Range" }, { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Timing.repeat.count" }, "comment": "If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.", "id": "MedicationRequest.dosageInstruction.timing.repeat.count", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.count" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.count", "requirements": "Repetitions may be limited by end time or total occurrences.", "short": "Number of times to repeat", "type": [ { "code": "positiveInt" } ] }, { "base": { "max": "1", "min": 0, "path": "Timing.repeat.countMax" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.", "id": "MedicationRequest.dosageInstruction.timing.repeat.countMax", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.count" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.countMax", "short": "Maximum number of times to repeat", "type": [ { "code": "positiveInt" } ] }, { "base": { "max": "1", "min": 0, "path": "Timing.repeat.duration" }, "comment": "For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.", "id": "MedicationRequest.dosageInstruction.timing.repeat.duration", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.phase" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.duration", "requirements": "Some activities are not instantaneous and need to be maintained for a period of time.", "short": "How long when it happens", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Timing.repeat.durationMax" }, "comment": "For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.", "id": "MedicationRequest.dosageInstruction.timing.repeat.durationMax", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.phase" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.durationMax", "requirements": "Some activities are not instantaneous and need to be maintained for a period of time.", "short": "How long when it happens (Max)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Timing.repeat.durationUnit" }, "binding": { "description": "A unit of time (units from UCUM).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "UnitsOfTime" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/units-of-time|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The units of time for the duration, in UCUM units.", "id": "MedicationRequest.dosageInstruction.timing.repeat.durationUnit", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.phase.unit" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.durationUnit", "short": "s | min | h | d | wk | mo | a - unit of time (UCUM)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Timing.repeat.frequency" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.", "id": "MedicationRequest.dosageInstruction.timing.repeat.frequency", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.phase" } ], "max": "1", "meaningWhenMissing": "If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.frequency", "short": "Event occurs frequency times per period", "type": [ { "code": "positiveInt" } ] }, { "base": { "max": "1", "min": 0, "path": "Timing.repeat.frequencyMax" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.", "id": "MedicationRequest.dosageInstruction.timing.repeat.frequencyMax", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.phase" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.frequencyMax", "short": "Event occurs up to frequencyMax times per period", "type": [ { "code": "positiveInt" } ] }, { "base": { "max": "1", "min": 0, "path": "Timing.repeat.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the duration of time over which repetitions are to occur; e.g. to express \"3 times per day\", 3 would be the frequency and \"1 day\" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.", "id": "MedicationRequest.dosageInstruction.timing.repeat.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.phase" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.period", "short": "Event occurs frequency times per period", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Timing.repeat.periodMax" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as \"do this once every 3-5 days.", "id": "MedicationRequest.dosageInstruction.timing.repeat.periodMax", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.phase" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.periodMax", "short": "Upper limit of period (3-4 hours)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Timing.repeat.periodUnit" }, "binding": { "description": "A unit of time (units from UCUM).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "UnitsOfTime" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/units-of-time|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The units of time for the period in UCUM units.", "id": "MedicationRequest.dosageInstruction.timing.repeat.periodUnit", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "PIVL.phase.unit" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.periodUnit", "short": "s | min | h | d | wk | mo | a - unit of time (UCUM)", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Timing.repeat.dayOfWeek" }, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DayOfWeek" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/days-of-week|4.0.1" }, "comment": "If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If one or more days of week is provided, then the action happens only on the specified day(s).", "id": "MedicationRequest.dosageInstruction.timing.repeat.dayOfWeek", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.dayOfWeek", "short": "mon | tue | wed | thu | fri | sat | sun", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Timing.repeat.timeOfDay" }, "comment": "When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specified time of day for action to take place.", "id": "MedicationRequest.dosageInstruction.timing.repeat.timeOfDay", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.timeOfDay", "short": "Time of day for action", "type": [ { "code": "time" } ] }, { "base": { "max": "*", "min": 0, "path": "Timing.repeat.when" }, "binding": { "description": "Real world event relating to the schedule.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EventTiming" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/event-timing|4.0.1" }, "comment": "When more than one event is listed, the event is tied to the union of the specified events.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.", "id": "MedicationRequest.dosageInstruction.timing.repeat.when", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "EIVL.event" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.when", "requirements": "Timings are frequently determined by occurrences such as waking, eating and sleep.", "short": "Code for time period of occurrence", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Timing.repeat.offset" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.", "id": "MedicationRequest.dosageInstruction.timing.repeat.offset", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "EIVL.offset" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.repeat.offset", "short": "Minutes from event (before or after)", "type": [ { "code": "unsignedInt" } ] }, { "base": { "max": "1", "min": 0, "path": "Timing.code" }, "binding": { "description": "Code for a known / defined timing pattern.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TimingAbbreviation" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/timing-abbreviation" }, "comment": "BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is \"always at 7am and 6pm\". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).", "id": "MedicationRequest.dosageInstruction.timing.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "QSC.code" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.timing.code", "short": "BID | TID | QID | AM | PM | QD | QOD | +", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Dosage.asNeeded[x]" }, "binding": { "description": "A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\" etc.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAsNeededReason" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/medication-as-needed-reason" }, "comment": "Can express \"as needed\" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express \"as needed\" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not \"prn\" or \"as needed\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).", "id": "MedicationRequest.dosageInstruction.asNeeded[x]", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "TQ1-9" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code=\"as needed\"].value=boolean or codable concept" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.asNeeded[x]", "short": "Take \"as needed\" (for x)", "type": [ { "code": "boolean" }, { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Dosage.site" }, "binding": { "description": "A coded concept describing the site location the medicine enters into or onto the body.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationSite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/approach-site-codes" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Body site to administer to.", "id": "MedicationRequest.dosageInstruction.site", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXR-2" }, { "identity": "rim", "map": ".approachSiteCode" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.site", "requirements": "A coded specification of the anatomic site where the medication first enters the body.", "short": "Body site to administer to", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Dosage.route" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/route-codes" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How drug should enter body.", "id": "MedicationRequest.dosageInstruction.route", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXR-1" }, { "identity": "rim", "map": ".routeCode" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.route", "requirements": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.", "short": "How drug should enter body", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.dosageInstruction.route.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.route.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.dosageInstruction.route.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction.route.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "MedicationRequest.dosageInstruction.route.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction.route.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.dosageInstruction.route.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.route.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.dosageInstruction.route.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction.route.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "MedicationRequest.dosageInstruction.route.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "MedicationRequest.dosageInstruction.route.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "MedicationRequest.dosageInstruction.route.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.route.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "MedicationRequest.dosageInstruction.route.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "MedicationRequest.dosageInstruction.route.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "MedicationRequest.dosageInstruction.route.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "MedicationRequest.dosageInstruction.route.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "MedicationRequest.dosageInstruction.route.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.route.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "MedicationRequest.dosageInstruction.route.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.route.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Dosage.method" }, "binding": { "description": "A coded concept describing the technique by which the medicine is administered.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationAdministrationMethod" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/administration-method-codes" }, "comment": "Terminologies used often pre-coordinate this term with the route and or form of administration.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Technique for administering medication.", "id": "MedicationRequest.dosageInstruction.method", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXR-4" }, { "identity": "rim", "map": ".doseQuantity" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.method", "requirements": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.", "short": "Technique for administering medication", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Dosage.doseAndRate" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The amount of medication administered.", "id": "MedicationRequest.dosageInstruction.doseAndRate", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "TQ1-2" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate", "short": "Amount of medication administered", "type": [ { "code": "Element" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.dosageInstruction.doseAndRate.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.dosageInstruction.doseAndRate.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Dosage.doseAndRate.type" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/dose-rate-type" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The kind of dose or rate specified, for example, ordered or calculated.", "id": "MedicationRequest.dosageInstruction.doseAndRate.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXO-21; RXE-23" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.type", "requirements": "If the type is not populated, assume to be \"ordered\".", "short": "The kind of dose or rate specified", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.dosageInstruction.doseAndRate.type.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.dosageInstruction.doseAndRate.type.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.type.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "MedicationRequest.dosageInstruction.doseAndRate.type.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "MedicationRequest.dosageInstruction.doseAndRate.type.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Dosage.doseAndRate.dose[x]" }, "comment": "Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Amount of medication per dose.", "id": "MedicationRequest.dosageInstruction.doseAndRate.dose[x]", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXO-2, RXE-3" }, { "identity": "rim", "map": ".doseQuantity" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.dose[x]", "requirements": "The amount of therapeutic or other substance given at one administration event.", "short": "Amount of medication per dose", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.value" }, "comment": "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", "id": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "SN.2 / CQ - N/A" }, { "identity": "rim", "map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value" } ], "max": "1", "min": 1, "path": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].value", "requirements": "Precision is handled implicitly in almost all cases of measurement.", "short": "Numerical value (with implicit precision)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.comparator" }, "binding": { "description": "How the Quantity should be understood and represented.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuantityComparator" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Not allowed to be used in this context", "id": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].comparator", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value", "isSummary": true, "mapping": [ { "identity": "v2", "map": "SN.1 / CQ.1" }, { "identity": "rim", "map": "IVL properties" } ], "max": "0", "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].comparator", "requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.", "short": "< | <= | >= | > - how to understand the value", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.unit" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable form of the unit.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].unit", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ], "max": "1", "min": 1, "path": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].unit", "requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.", "short": "Unit representation", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.system" }, "condition": [ "qty-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the system that provides the coded form of the unit.", "id": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "CO.codeSystem, PQ.translation.codeSystem" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].system", "requirements": "Need to know the system that defines the coded form of the unit.", "short": "System that defines coded unit form", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Quantity.code" }, "comment": "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A computer processable form of the unit in some unit representation system.", "id": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.code, MO.currency, PQ.translation.code" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.dose[x].code", "requirements": "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.", "short": "Coded form of the unit", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Dosage.doseAndRate.rate[x]" }, "comment": "It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate.\r\rIt is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Amount of medication per unit of time.", "id": "MedicationRequest.dosageInstruction.doseAndRate.rate[x]", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXE22, RXE23, RXE-24" }, { "identity": "rim", "map": ".rateQuantity" } ], "max": "1", "min": 0, "path": "MedicationRequest.dosageInstruction.doseAndRate.rate[x]", "requirements": "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. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.", "short": "Amount of medication per unit of time", "type": [ { "code": "Ratio" }, { "code": "Range" }, { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Dosage.maxDosePerPeriod" }, "comment": "This is intended for use as an adjunct to the dosage when there is an upper cap. For example \"2 tablets every 4 hours to a maximum of 8/day\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Upper limit on medication per unit of time.", "id": "MedicationRequest.dosageInstruction.maxDosePerPeriod", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "RXO-23, RXE-19" }, { "identity": "rim", "map": ".maxDoseQuantity" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.maxDosePerPeriod", "requirements": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.", "short": "Upper limit on medication per unit of time", "type": [ { "code": "Ratio" } ] }, { "base": { "max": "1", "min": 0, "path": "Dosage.maxDosePerAdministration" }, "comment": "This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Upper limit on medication per administration.", "id": "MedicationRequest.dosageInstruction.maxDosePerAdministration", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "not supported" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.maxDosePerAdministration", "requirements": "The maximum total quantity of a therapeutic substance that may be administered to a subject per administration.", "short": "Upper limit on medication per administration", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Dosage.maxDosePerLifetime" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Upper limit on medication per lifetime of the patient.", "id": "MedicationRequest.dosageInstruction.maxDosePerLifetime", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "not supported" } ], "max": "0", "min": 0, "path": "MedicationRequest.dosageInstruction.maxDosePerLifetime", "requirements": "The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.", "short": "Upper limit on medication per lifetime of the patient", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "MedicationRequest.dispenseRequest", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "script10.6", "map": "Message/Body/NewRx/MedicationPrescribed/ExpirationDate" }, { "identity": "rim", "map": "component.supplyEvent" } ], "max": "0", "min": 0, "path": "MedicationRequest.dispenseRequest", "short": "Medication supply authorization", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.dispenseRequest.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.dispenseRequest.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.dispenseRequest.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "MedicationRequest.dispenseRequest.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "MedicationRequest.dispenseRequest.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.initialFill" }, "comment": "If populating this element, either the quantity or the duration must be included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the quantity or duration for the first dispense of the medication.", "id": "MedicationRequest.dispenseRequest.initialFill", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "SubstanceAdministration -> ActRelationship[sequenceNumber = '1'] -> Supply" } ], "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.initialFill", "short": "First fill details", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.dispenseRequest.initialFill.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.initialFill.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.dispenseRequest.initialFill.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.dispenseRequest.initialFill.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "MedicationRequest.dispenseRequest.initialFill.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "MedicationRequest.dispenseRequest.initialFill.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.initialFill.quantity" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The amount or quantity to provide as part of the first dispense.", "id": "MedicationRequest.dispenseRequest.initialFill.quantity", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Supply.quantity[moodCode=RQO]" } ], "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.initialFill.quantity", "short": "First fill quantity", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.initialFill.duration" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The length of time that the first dispense is expected to last.", "id": "MedicationRequest.dispenseRequest.initialFill.duration", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Supply.effectivetime[moodCode=RQO]" } ], "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.initialFill.duration", "short": "First fill duration", "type": [ { "code": "Duration" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.dispenseInterval" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The minimum period of time that must occur between dispenses of the medication.", "id": "MedicationRequest.dispenseRequest.dispenseInterval", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Supply.effectivetime[moodCode=RQO]" } ], "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.dispenseInterval", "short": "Minimum period of time between dispenses", "type": [ { "code": "Duration" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.validityPeriod" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This indicates the validity period of a prescription (stale dating the Prescription).", "id": "MedicationRequest.dispenseRequest.validityPeriod", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "script10.6", "map": "Message/Body/NewRx/MedicationPrescribed/Refills" }, { "identity": "rim", "map": "effectiveTime" } ], "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.validityPeriod", "requirements": "Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.", "short": "Time period supply is authorized for", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.numberOfRepeatsAllowed" }, "comment": "If displaying \"number of authorized fills\", add 1 to this number.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "MedicationRequest.dispenseRequest.numberOfRepeatsAllowed", "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" } ], "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.numberOfRepeatsAllowed", "short": "Number of refills authorized", "type": [ { "code": "unsignedInt" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.quantity" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The amount that is to be dispensed for one fill.", "id": "MedicationRequest.dispenseRequest.quantity", "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" } ], "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.quantity", "short": "Amount of medication to supply per dispense", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.expectedSupplyDuration" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "MedicationRequest.dispenseRequest.expectedSupplyDuration", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "script10.6", "map": "Message/Body/NewRx/MedicationPrescribed/Substitutions" }, { "identity": "rim", "map": "expectedUseTime" } ], "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.expectedSupplyDuration", "short": "Number of days supply per dispense", "type": [ { "code": "Duration" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.performer" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the intended dispensing Organization specified by the prescriber.", "id": "MedicationRequest.dispenseRequest.performer", "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]" } ], "max": "1", "min": 0, "path": "MedicationRequest.dispenseRequest.performer", "short": "Intended dispenser", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.substitution" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "MedicationRequest.substitution", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "script10.6", "map": "specific values within Message/Body/NewRx/MedicationPrescribed/Substitutions" }, { "identity": "rim", "map": "subjectOf.substitutionPersmission" } ], "max": "0", "min": 0, "path": "MedicationRequest.substitution", "short": "Any restrictions on medication substitution", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "MedicationRequest.substitution.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "MedicationRequest.substitution.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "MedicationRequest.substitution.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "MedicationRequest.substitution.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "MedicationRequest.substitution.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "MedicationRequest.substitution.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "MedicationRequest.substitution.allowed[x]" }, "binding": { "description": "Identifies the type of substitution allowed.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationRequestSubstitution" } ], "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode" }, "comment": "This element is labeled as a modifier because whether substitution is allow or not, it cannot be ignored.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "True if the prescriber allows a different drug to be dispensed from what was prescribed.", "id": "MedicationRequest.substitution.allowed[x]", "isModifier": false, "isSummary": false, "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" } ], "max": "1", "min": 1, "path": "MedicationRequest.substitution.allowed[x]", "short": "Whether substitution is allowed or not", "type": [ { "code": "boolean" }, { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.substitution.reason" }, "binding": { "description": "A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MedicationIntendedSubstitutionReason" } ], "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the reason for the substitution, or why substitution must or must not be performed.", "id": "MedicationRequest.substitution.reason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "script10.6", "map": "not mapped" }, { "identity": "v2", "map": "RXE-9 Substition status" }, { "identity": "rim", "map": "reasonCode" } ], "max": "1", "min": 0, "path": "MedicationRequest.substitution.reason", "short": "Why should (not) substitution be made", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "MedicationRequest.priorPrescription" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A link to a resource representing an earlier order related order or prescription.", "id": "MedicationRequest.priorPrescription", "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]" } ], "max": "0", "min": 0, "path": "MedicationRequest.priorPrescription", "short": "An order/prescription that is being replaced", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/MedicationRequest" ] } ] }, { "alias": [ "Contraindication", "Drug Utilization Review (DUR)", "Alert" ], "base": { "max": "*", "min": 0, "path": "MedicationRequest.detectedIssue" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "MedicationRequest.detectedIssue", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ]/source[classCode=ALRT,moodCode=EVN].value" } ], "max": "0", "min": 0, "path": "MedicationRequest.detectedIssue", "short": "Clinical Issue with action", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DetectedIssue" ] } ] }, { "base": { "max": "*", "min": 0, "path": "MedicationRequest.eventHistory" }, "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.).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "MedicationRequest.eventHistory", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.relevantHistory" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "MedicationRequest.eventHistory", "short": "A list of events of interest in the lifecycle", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Provenance" ] } ] } ] }, "status": "draft", "title": "OneHealth MedicationRequest", "type": "MedicationRequest", "url": "https://fhir.onehealth.com.pe/StructureDefinition/MedicationRequestOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/LocationOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Location", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2023-12-05", "derivation": "constraint", "description": "FHIR LocationOH, for OH interoperability scenarios, based on the national CORE Location Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Location.identifier", "min": 1, "path": "Location.identifier" }, { "id": "Location.identifier.use", "min": 1, "path": "Location.identifier.use" }, { "id": "Location.identifier.type", "max": "0", "path": "Location.identifier.type" }, { "id": "Location.identifier.system", "min": 1, "path": "Location.identifier.system", "patternUri": "http://www.onehealth.com/SUSALUD" }, { "id": "Location.identifier.value", "min": 1, "path": "Location.identifier.value" }, { "id": "Location.identifier.period", "max": "0", "path": "Location.identifier.period" }, { "id": "Location.identifier.assigner", "min": 1, "path": "Location.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Location.status", "min": 1, "path": "Location.status" }, { "id": "Location.operationalStatus", "max": "0", "path": "Location.operationalStatus" }, { "id": "Location.name", "min": 1, "path": "Location.name" }, { "id": "Location.alias", "max": "1", "path": "Location.alias" }, { "id": "Location.description", "min": 1, "path": "Location.description" }, { "id": "Location.mode", "max": "0", "path": "Location.mode" }, { "binding": { "description": "Physical form of the location.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PhysicalType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/location-physical-type" }, "id": "Location.physicalType", "min": 1, "path": "Location.physicalType" }, { "id": "Location.managingOrganization", "min": 1, "path": "Location.managingOrganization", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Location.partOf", "max": "0", "path": "Location.partOf" }, { "id": "Location.availabilityExceptions", "max": "0", "path": "Location.availabilityExceptions" }, { "id": "Location.endpoint", "max": "0", "path": "Location.endpoint" } ] }, "fhirVersion": "4.0.1", "id": "LocationOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" } ], "meta": { "lastUpdated": "2024-04-12T17:46:22.399968+00:00", "versionId": "MTcxMjk0Mzk4MjM5OTk2ODAwMA" }, "name": "LocationOH", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Location" }, "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.", "id": "Location", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": ".Role[classCode=SDLC]" } ], "max": "*", "min": 0, "path": "Location", "short": "Details and position information for a physical place" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Location.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Location.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Location.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Location.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Location.implicitRules", "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, "max": "1", "min": 0, "path": "Location.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Location.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Location.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Location.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Location.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Location.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Location.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Location.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Location.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Location.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Location.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Location.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Unique code or number identifying the location to its users.", "id": "Location.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": ".id" } ], "max": "*", "min": 1, "path": "Location.identifier", "requirements": "Organization label locations in registries, need to keep track of those.", "short": "Unique code or number identifying the location to its users", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Location.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Location.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Location.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Location.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "Location.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "Location.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "Location.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "Location.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "Location.identifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 1, "path": "Location.identifier.system", "patternUri": "http://www.onehealth.com/SUSALUD", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "example": [ { "label": "General", "valueString": "123456" } ], "id": "Location.identifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Location.identifier.value", "short": "The value that is unique", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "Location.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Location.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "Location.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 1, "path": "Location.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Location.status" }, "binding": { "description": "Indicates whether the location is still in use.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "LocationStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/location-status|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.", "id": "Location.status", "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid", "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": ".statusCode" } ], "max": "1", "min": 1, "path": "Location.status", "short": "active | suspended | inactive", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Location.operationalStatus" }, "binding": { "description": "The operational status if the location (where typically a bed/room).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "OperationalStatus" } ], "strength": "preferred", "valueSet": "http://terminology.hl7.org/ValueSet/v2-0116" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.", "id": "Location.operationalStatus", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Location.operationalStatus", "short": "The operational status of the location (typically only for a bed/room)", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Location.name" }, "comment": "If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Name of the location as used by humans. Does not need to be unique.", "id": "Location.name", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".name" } ], "max": "1", "min": 1, "path": "Location.name", "short": "Name of the location as used by humans", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Location.alias" }, "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 location.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A list of alternate names that the location is known as, or was known as, in the past.", "id": "Location.alias", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".name" } ], "max": "1", "min": 0, "path": "Location.alias", "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 location was known by can be very useful.", "short": "A list of alternate names that the location is known as, or was known as, in the past", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Location.description" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Description of the Location, which helps in finding or referencing the place.", "id": "Location.description", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".playingEntity[classCode=PLC determinerCode=INSTANCE].desc" } ], "max": "1", "min": 1, "path": "Location.description", "requirements": "Humans need additional information to verify a correct location has been identified.", "short": "Additional details about the location that could be displayed as further information to identify the location beyond its name", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Location.mode" }, "binding": { "description": "Indicates whether a resource instance represents a specific location or a class of locations.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "LocationMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/location-mode|4.0.1" }, "comment": "This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates whether a resource instance represents a specific location or a class of locations.", "id": "Location.mode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".playingEntity[classCode=PLC].determinerCode" } ], "max": "0", "min": 0, "path": "Location.mode", "requirements": "When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.", "short": "instance | kind", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Location.type" }, "binding": { "description": "Indicates the type of function performed at the location.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "LocationType" } ], "strength": "extensible", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the type of function performed at the location.", "id": "Location.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".code" } ], "max": "*", "min": 0, "path": "Location.type", "short": "Type of function performed", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Location.telecom" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.", "id": "Location.telecom", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".telecom" } ], "max": "*", "min": 0, "path": "Location.telecom", "short": "Contact details of the location", "type": [ { "code": "ContactPoint" } ] }, { "base": { "max": "1", "min": 0, "path": "Location.address" }, "comment": "Additional addresses should be recorded using another instance of the Location resource, or via the Organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Physical location.", "id": "Location.address", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".addr" } ], "max": "1", "min": 0, "path": "Location.address", "requirements": "If locations can be visited, we need to keep track of their address.", "short": "Physical location", "type": [ { "code": "Address" } ] }, { "base": { "max": "1", "min": 0, "path": "Location.physicalType" }, "binding": { "description": "Physical form of the location.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PhysicalType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/location-physical-type" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Physical form of the location, e.g. building, room, vehicle, road.", "id": "Location.physicalType", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".playingEntity [classCode=PLC].code" } ], "max": "1", "min": 1, "path": "Location.physicalType", "requirements": "For purposes of showing relevant locations in queries, we need to categorize locations.", "short": "Physical form of the location", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Location.position" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).", "id": "Location.position", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".playingEntity [classCode=PLC determinerCode=INSTANCE].positionText" } ], "max": "1", "min": 0, "path": "Location.position", "requirements": "For mobile applications and automated route-finding knowing the exact location of the Location is required.", "short": "The absolute geographic location", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Location.position.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Location.position.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Location.position.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Location.position.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Location.position.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Location.position.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Location.position.longitude" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).", "id": "Location.position.longitude", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)" } ], "max": "1", "min": 1, "path": "Location.position.longitude", "short": "Longitude with WGS84 datum", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 1, "path": "Location.position.latitude" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).", "id": "Location.position.latitude", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)" } ], "max": "1", "min": 1, "path": "Location.position.latitude", "short": "Latitude with WGS84 datum", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Location.position.altitude" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).", "id": "Location.position.altitude", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)" } ], "max": "1", "min": 0, "path": "Location.position.altitude", "short": "Altitude with WGS84 datum", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Location.managingOrganization" }, "comment": "This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The organization responsible for the provisioning and upkeep of the location.", "id": "Location.managingOrganization", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".scopingEntity[classCode=ORG determinerKind=INSTANCE]" } ], "max": "1", "min": 1, "path": "Location.managingOrganization", "requirements": "Need to know who manages the location.", "short": "Organization responsible for provisioning and upkeep", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Location.partOf" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Another Location of which this Location is physically a part of.", "id": "Location.partOf", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".inboundLink[typeCode=PART].source[classCode=SDLC]" } ], "max": "0", "min": 0, "path": "Location.partOf", "requirements": "For purposes of location, display and identification, knowing which locations are located within other locations is important.", "short": "Another Location this one is physically a part of", "type": [ { "code": "Reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", "valueBoolean": true } ], "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Location.hoursOfOperation" }, "comment": "This type of information is commonly found published in directories and on websites informing customers when the facility is available.\n\nSpecific services within the location may have their own hours which could be shorter (or longer) than the locations hours.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "What days/times during a week is this location usually open.", "id": "Location.hoursOfOperation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "*", "min": 0, "path": "Location.hoursOfOperation", "short": "What days/times during a week is this location usually open", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Location.hoursOfOperation.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Location.hoursOfOperation.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Location.hoursOfOperation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Location.hoursOfOperation.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Location.hoursOfOperation.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Location.hoursOfOperation.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Location.hoursOfOperation.daysOfWeek" }, "binding": { "description": "The days of the week.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DaysOfWeek" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/days-of-week|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates which days of the week are available between the start and end Times.", "id": "Location.hoursOfOperation.daysOfWeek", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "*", "min": 0, "path": "Location.hoursOfOperation.daysOfWeek", "short": "mon | tue | wed | thu | fri | sat | sun", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Location.hoursOfOperation.allDay" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Location is open all day.", "id": "Location.hoursOfOperation.allDay", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 0, "path": "Location.hoursOfOperation.allDay", "short": "The Location is open all day", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "Location.hoursOfOperation.openingTime" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time that the Location opens.", "id": "Location.hoursOfOperation.openingTime", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 0, "path": "Location.hoursOfOperation.openingTime", "short": "Time that the Location opens", "type": [ { "code": "time" } ] }, { "base": { "max": "1", "min": 0, "path": "Location.hoursOfOperation.closingTime" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time that the Location closes.", "id": "Location.hoursOfOperation.closingTime", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 0, "path": "Location.hoursOfOperation.closingTime", "short": "Time that the Location closes", "type": [ { "code": "time" } ] }, { "base": { "max": "1", "min": 0, "path": "Location.availabilityExceptions" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.", "id": "Location.availabilityExceptions", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Location.availabilityExceptions", "short": "Description of availability exceptions", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Location.endpoint" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Technical endpoints providing access to services operated for the location.", "id": "Location.endpoint", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Location.endpoint", "requirements": "Organizations may have different systems at different locations 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.", "short": "Technical endpoints providing access to services operated for the location", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Endpoint" ] } ] } ] }, "status": "draft", "title": "OneHealth Location", "type": "Location", "url": "https://fhir.onehealth.com.pe/StructureDefinition/LocationOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/HealthcareServiceOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/HealthcareService", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2023-12-05", "derivation": "constraint", "description": "FHIR HealthcareServiceOH, for OH interoperability scenarios, based on the national CORE HealthcareService Profile defined by HL7 OH.", "differential": { "element": [ { "id": "HealthcareService.identifier", "max": "1", "min": 1, "path": "HealthcareService.identifier" }, { "id": "HealthcareService.identifier.use", "min": 1, "path": "HealthcareService.identifier.use" }, { "id": "HealthcareService.identifier.type", "max": "0", "path": "HealthcareService.identifier.type" }, { "id": "HealthcareService.identifier.system", "max": "0", "path": "HealthcareService.identifier.system" }, { "id": "HealthcareService.identifier.value", "min": 1, "path": "HealthcareService.identifier.value" }, { "id": "HealthcareService.identifier.period", "max": "0", "path": "HealthcareService.identifier.period" }, { "id": "HealthcareService.identifier.assigner", "min": 1, "path": "HealthcareService.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "HealthcareService.active", "min": 1, "path": "HealthcareService.active" }, { "id": "HealthcareService.providedBy", "min": 1, "path": "HealthcareService.providedBy", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "HealthcareService.category", "max": "0", "path": "HealthcareService.category" }, { "id": "HealthcareService.type", "max": "1", "path": "HealthcareService.type" }, { "id": "HealthcareService.type.coding", "max": "1", "min": 1, "path": "HealthcareService.type.coding" }, { "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/HealthcareServicesOH" }, "id": "HealthcareService.type.coding.system", "min": 1, "path": "HealthcareService.type.coding.system" }, { "id": "HealthcareService.type.coding.version", "max": "0", "path": "HealthcareService.type.coding.version" }, { "id": "HealthcareService.type.coding.code", "min": 1, "path": "HealthcareService.type.coding.code" }, { "id": "HealthcareService.type.coding.display", "min": 1, "path": "HealthcareService.type.coding.display" }, { "id": "HealthcareService.type.coding.userSelected", "max": "0", "path": "HealthcareService.type.coding.userSelected" }, { "id": "HealthcareService.type.text", "max": "0", "path": "HealthcareService.type.text" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/c80-practice-codes" }, "id": "HealthcareService.specialty", "min": 1, "path": "HealthcareService.specialty" }, { "id": "HealthcareService.specialty.coding", "min": 1, "path": "HealthcareService.specialty.coding" }, { "id": "HealthcareService.specialty.coding.system", "min": 1, "path": "HealthcareService.specialty.coding.system" }, { "id": "HealthcareService.specialty.coding.version", "max": "0", "path": "HealthcareService.specialty.coding.version" }, { "id": "HealthcareService.specialty.coding.code", "min": 1, "path": "HealthcareService.specialty.coding.code" }, { "id": "HealthcareService.specialty.coding.display", "min": 1, "path": "HealthcareService.specialty.coding.display" }, { "id": "HealthcareService.specialty.coding.userSelected", "max": "0", "path": "HealthcareService.specialty.coding.userSelected" }, { "id": "HealthcareService.specialty.text", "max": "0", "path": "HealthcareService.specialty.text" }, { "id": "HealthcareService.location", "min": 1, "path": "HealthcareService.location", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/LocationOH" ] } ] }, { "id": "HealthcareService.name", "min": 1, "path": "HealthcareService.name" }, { "id": "HealthcareService.comment", "max": "0", "path": "HealthcareService.comment" }, { "id": "HealthcareService.extraDetails", "max": "0", "path": "HealthcareService.extraDetails" }, { "id": "HealthcareService.photo", "max": "0", "path": "HealthcareService.photo" }, { "id": "HealthcareService.telecom", "max": "0", "path": "HealthcareService.telecom" }, { "id": "HealthcareService.coverageArea", "max": "0", "path": "HealthcareService.coverageArea" }, { "id": "HealthcareService.serviceProvisionCode", "max": "0", "path": "HealthcareService.serviceProvisionCode" }, { "id": "HealthcareService.eligibility", "max": "0", "path": "HealthcareService.eligibility" }, { "id": "HealthcareService.program", "max": "0", "path": "HealthcareService.program" }, { "id": "HealthcareService.characteristic", "max": "0", "path": "HealthcareService.characteristic" }, { "id": "HealthcareService.communication", "max": "0", "path": "HealthcareService.communication" }, { "id": "HealthcareService.referralMethod", "max": "0", "path": "HealthcareService.referralMethod" }, { "id": "HealthcareService.appointmentRequired", "max": "0", "path": "HealthcareService.appointmentRequired" }, { "id": "HealthcareService.availableTime", "max": "0", "path": "HealthcareService.availableTime" }, { "id": "HealthcareService.notAvailable", "max": "0", "path": "HealthcareService.notAvailable" }, { "id": "HealthcareService.availabilityExceptions", "max": "0", "path": "HealthcareService.availabilityExceptions" }, { "id": "HealthcareService.endpoint", "max": "0", "path": "HealthcareService.endpoint" } ] }, "fhirVersion": "4.0.1", "id": "HealthcareServiceOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" } ], "meta": { "lastUpdated": "2024-04-12T17:46:22.21845+00:00", "versionId": "MTcxMjk0Mzk4MjIxODQ1MDAwMA" }, "name": "HealthcareServiceOH", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "HealthcareService" }, "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "The details of a healthcare service available at a location.", "id": "HealthcareService", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "act[classCode=ACT][moodCode=DEF]" } ], "max": "*", "min": 0, "path": "HealthcareService", "short": "The details of a healthcare service available at a location" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "HealthcareService.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "HealthcareService.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "HealthcareService.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "HealthcareService.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "HealthcareService.implicitRules", "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, "max": "1", "min": 0, "path": "HealthcareService.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "HealthcareService.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "HealthcareService.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "HealthcareService.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "HealthcareService.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "HealthcareService.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "HealthcareService.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "HealthcareService.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "HealthcareService.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "HealthcareService.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "HealthcareService.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "External identifiers for this item.", "id": "HealthcareService.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": ".id" } ], "max": "1", "min": 1, "path": "HealthcareService.identifier", "short": "External identifiers for this item", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "HealthcareService.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "HealthcareService.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "HealthcareService.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "HealthcareService.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "HealthcareService.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 1, "path": "HealthcareService.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "HealthcareService.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "HealthcareService.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "HealthcareService.identifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "0", "min": 0, "path": "HealthcareService.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "example": [ { "label": "General", "valueString": "123456" } ], "id": "HealthcareService.identifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "HealthcareService.identifier.value", "short": "The value that is unique", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "HealthcareService.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "HealthcareService.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "HealthcareService.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 1, "path": "HealthcareService.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "HealthcareService.active" }, "comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.", "id": "HealthcareService.active", "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" } ], "max": "1", "meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element", "min": 1, "path": "HealthcareService.active", "short": "Whether this HealthcareService record is in active use", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "HealthcareService.providedBy" }, "comment": "This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The organization that provides this healthcare service.", "id": "HealthcareService.providedBy", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".scopingRole.Organization" } ], "max": "1", "min": 1, "path": "HealthcareService.providedBy", "short": "Organization that provides this service", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "alias": [ "service category" ], "base": { "max": "*", "min": 0, "path": "HealthcareService.category" }, "binding": { "description": "A category of the service(s) that could be provided.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "service-category" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/service-category" }, "comment": "Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the broad category of service being performed or delivered.", "id": "HealthcareService.category", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".code" } ], "max": "0", "min": 0, "path": "HealthcareService.category", "short": "Broad category of service being performed or delivered", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "service type" ], "base": { "max": "*", "min": 0, "path": "HealthcareService.type" }, "binding": { "description": "Additional details about where the content was created (e.g. clinical specialty).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "service-type" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/service-type" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The specific type of service that may be delivered or performed.", "id": "HealthcareService.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code" } ], "max": "1", "min": 0, "path": "HealthcareService.type", "short": "Type of service that may be delivered or performed", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "HealthcareService.type.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "HealthcareService.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "HealthcareService.type.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "HealthcareService.type.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "HealthcareService.type.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "HealthcareService.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "HealthcareService.type.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "HealthcareService.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "HealthcareService.type.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "HealthcareService.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/HealthcareServicesOH" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "HealthcareService.type.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "HealthcareService.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "HealthcareService.type.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "HealthcareService.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "HealthcareService.type.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "HealthcareService.type.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "HealthcareService.type.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "HealthcareService.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "HealthcareService.type.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "HealthcareService.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "HealthcareService.type.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "HealthcareService.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.specialty" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/c80-practice-codes" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Collection of specialties handled by the service site. This is more of a medical term.", "id": "HealthcareService.specialty", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code" } ], "max": "*", "min": 1, "path": "HealthcareService.specialty", "short": "Specialties handled by the HealthcareService", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "HealthcareService.specialty.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "HealthcareService.specialty.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "HealthcareService.specialty.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "HealthcareService.specialty.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "HealthcareService.specialty.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 1, "path": "HealthcareService.specialty.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "HealthcareService.specialty.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "HealthcareService.specialty.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "HealthcareService.specialty.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "HealthcareService.specialty.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "HealthcareService.specialty.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "HealthcareService.specialty.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "HealthcareService.specialty.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "HealthcareService.specialty.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "HealthcareService.specialty.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "HealthcareService.specialty.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "HealthcareService.specialty.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "HealthcareService.specialty.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "HealthcareService.specialty.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "HealthcareService.specialty.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "HealthcareService.specialty.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "HealthcareService.specialty.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location(s) where this healthcare service may be provided.", "id": "HealthcareService.location", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.where[x]" }, { "identity": "rim", "map": ".location.role[classCode=SDLOC]" } ], "max": "*", "min": 1, "path": "HealthcareService.location", "short": "Location(s) where service may be provided", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/LocationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "HealthcareService.name" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Further description of the service as it would be presented to a consumer while searching.", "id": "HealthcareService.name", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".name" } ], "max": "1", "min": 1, "path": "HealthcareService.name", "short": "Description of service as presented to a consumer while searching", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "HealthcareService.comment" }, "comment": "Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.", "id": "HealthcareService.comment", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".location.role[classCode=SDLOC].desc" } ], "max": "0", "min": 0, "path": "HealthcareService.comment", "short": "Additional description and/or any specific issues not covered elsewhere", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "HealthcareService.extraDetails" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Extra details about the service that can't be placed in the other fields.", "id": "HealthcareService.extraDetails", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].text" } ], "max": "0", "min": 0, "path": "HealthcareService.extraDetails", "short": "Extra details about the service that can't be placed in the other fields", "type": [ { "code": "markdown" } ] }, { "base": { "max": "1", "min": 0, "path": "HealthcareService.photo" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.", "id": "HealthcareService.photo", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".actrelationship[typeCode=SBJ].observation.value" } ], "max": "0", "min": 0, "path": "HealthcareService.photo", "short": "Facilitates quick identification of the service", "type": [ { "code": "Attachment" } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.telecom" }, "comment": "If this is empty, then refer to the location's contacts.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "List of contacts related to this specific healthcare service.", "id": "HealthcareService.telecom", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".telecom" } ], "max": "0", "min": 0, "path": "HealthcareService.telecom", "short": "Contacts related to the healthcare service", "type": [ { "code": "ContactPoint" } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.coverageArea" }, "comment": "The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as \"in-home\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location(s) that this service is available to (not where the service is provided).", "id": "HealthcareService.coverageArea", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".location.role[classCode=SDLOC].subjectOf.A_SpatialCoordinate" } ], "max": "0", "min": 0, "path": "HealthcareService.coverageArea", "short": "Location(s) service is intended for/available to", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ] } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.serviceProvisionCode" }, "binding": { "description": "The code(s) that detail the conditions under which the healthcare service is available/offered.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ServiceProvisionConditions" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/service-provision-conditions" }, "comment": "The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The code(s) that detail the conditions under which the healthcare service is available/offered.", "id": "HealthcareService.serviceProvisionCode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]" } ], "max": "0", "min": 0, "path": "HealthcareService.serviceProvisionCode", "short": "Conditions under which service is available/offered", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.eligibility" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Does this service have specific eligibility requirements that need to be met in order to use the service?", "id": "HealthcareService.eligibility", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "HealthcareService.eligibility", "short": "Specific eligibility requirements required to use the service", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "HealthcareService.eligibility.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "HealthcareService.eligibility.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "HealthcareService.eligibility.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "HealthcareService.eligibility.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "HealthcareService.eligibility.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "HealthcareService.eligibility.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "HealthcareService.eligibility.code" }, "binding": { "description": "Coded values underwhich a specific service is made available.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ServiceEligibility" } ], "strength": "example" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Coded value for the eligibility.", "id": "HealthcareService.eligibility.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]" } ], "max": "1", "min": 0, "path": "HealthcareService.eligibility.code", "short": "Coded value for the eligibility", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "HealthcareService.eligibility.comment" }, "comment": "The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes the eligibility conditions for the service.", "id": "HealthcareService.eligibility.comment", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text" } ], "max": "1", "min": 0, "path": "HealthcareService.eligibility.comment", "short": "Describes the eligibility conditions for the service", "type": [ { "code": "markdown" } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.program" }, "binding": { "description": "Government or local programs that this service applies to.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Program" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/program" }, "comment": "Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Programs that this service is applicable to.", "id": "HealthcareService.program", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".actrelationship[typeCode=PERT].observation" } ], "max": "0", "min": 0, "path": "HealthcareService.program", "short": "Programs that this service is applicable to", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.characteristic" }, "binding": { "description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ServiceCharacteristic" } ], "strength": "example" }, "comment": "These could be such things as is wheelchair accessible.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Collection of characteristics (attributes).", "id": "HealthcareService.characteristic", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".actrelationship[typeCode=PERT].observation" } ], "max": "0", "min": 0, "path": "HealthcareService.characteristic", "short": "Collection of characteristics (attributes)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.communication" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "comment": "When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.", "id": "HealthcareService.communication", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "HealthcareService.communication", "short": "The language that this service is offered in", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.referralMethod" }, "binding": { "description": "The methods of referral can be used when referring to a specific HealthCareService resource.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ReferralMethod" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/service-referral-method" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.", "id": "HealthcareService.referralMethod", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".actrelationship[typeCode=PERT].observation" } ], "max": "0", "min": 0, "path": "HealthcareService.referralMethod", "short": "Ways that the service accepts referrals", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "HealthcareService.appointmentRequired" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.", "id": "HealthcareService.appointmentRequired", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".actrelationship[typeCode=PERT].observation" } ], "max": "0", "min": 0, "path": "HealthcareService.appointmentRequired", "short": "If an appointment is required for access to this service", "type": [ { "code": "boolean" } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.availableTime" }, "comment": "More detailed availability information may be provided in associated Schedule/Slot resources.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A collection of times that the Service Site is available.", "id": "HealthcareService.availableTime", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "0", "min": 0, "path": "HealthcareService.availableTime", "short": "Times the Service Site is available", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "HealthcareService.availableTime.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "HealthcareService.availableTime.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "HealthcareService.availableTime.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "HealthcareService.availableTime.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "HealthcareService.availableTime.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "HealthcareService.availableTime.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.availableTime.daysOfWeek" }, "binding": { "description": "The days of the week.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DaysOfWeek" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/days-of-week|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates which days of the week are available between the start and end Times.", "id": "HealthcareService.availableTime.daysOfWeek", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "*", "min": 0, "path": "HealthcareService.availableTime.daysOfWeek", "short": "mon | tue | wed | thu | fri | sat | sun", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "HealthcareService.availableTime.allDay" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Is this always available? (hence times are irrelevant) e.g. 24 hour service.", "id": "HealthcareService.availableTime.allDay", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 0, "path": "HealthcareService.availableTime.allDay", "short": "Always available? e.g. 24 hour service", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "HealthcareService.availableTime.availableStartTime" }, "comment": "The time zone is expected to be for where this HealthcareService is provided at.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.", "id": "HealthcareService.availableTime.availableStartTime", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 0, "path": "HealthcareService.availableTime.availableStartTime", "short": "Opening time of day (ignored if allDay = true)", "type": [ { "code": "time" } ] }, { "base": { "max": "1", "min": 0, "path": "HealthcareService.availableTime.availableEndTime" }, "comment": "The time zone is expected to be for where this HealthcareService is provided at.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.", "id": "HealthcareService.availableTime.availableEndTime", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 0, "path": "HealthcareService.availableTime.availableEndTime", "short": "Closing time of day (ignored if allDay = true)", "type": [ { "code": "time" } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.notAvailable" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The HealthcareService is not available during this period of time due to the provided reason.", "id": "HealthcareService.notAvailable", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "0", "min": 0, "path": "HealthcareService.notAvailable", "short": "Not available during this time due to provided reason", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "HealthcareService.notAvailable.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "HealthcareService.notAvailable.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "HealthcareService.notAvailable.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "HealthcareService.notAvailable.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "HealthcareService.notAvailable.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "HealthcareService.notAvailable.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "HealthcareService.notAvailable.description" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The reason that can be presented to the user as to why this time is not available.", "id": "HealthcareService.notAvailable.description", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "HealthcareService.notAvailable.description", "short": "Reason presented to the user explaining why time not available", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "HealthcareService.notAvailable.during" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Service is not available (seasonally or for a public holiday) from this date.", "id": "HealthcareService.notAvailable.during", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 0, "path": "HealthcareService.notAvailable.during", "short": "Service not available from this date", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "HealthcareService.availabilityExceptions" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "HealthcareService.availabilityExceptions", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".effectiveTime" } ], "max": "0", "min": 0, "path": "HealthcareService.availabilityExceptions", "short": "Description of availability exceptions", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "HealthcareService.endpoint" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.", "id": "HealthcareService.endpoint", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "HealthcareService.endpoint", "short": "Technical endpoints providing access to electronic services operated for the healthcare service", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Endpoint" ] } ] } ] }, "status": "draft", "title": "OneHealth HealthcareService", "type": "HealthcareService", "url": "https://fhir.onehealth.com.pe/StructureDefinition/HealthcareServiceOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/GroupOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Group", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2023-12-05", "derivation": "constraint", "description": "FHIR GroupOH Profile, for OH interoperability scenarios, based on the national CORE Group Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Group.identifier", "max": "1", "min": 1, "path": "Group.identifier" }, { "id": "Group.identifier.use", "max": "0", "path": "Group.identifier.use" }, { "id": "Group.identifier.type", "max": "0", "path": "Group.identifier.type" }, { "id": "Group.identifier.system", "min": 1, "path": "Group.identifier.system" }, { "id": "Group.identifier.value", "min": 1, "path": "Group.identifier.value" }, { "id": "Group.identifier.period", "max": "0", "path": "Group.identifier.period" }, { "id": "Group.identifier.assigner", "path": "Group.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "fixedCode": "person", "id": "Group.type", "path": "Group.type" }, { "fixedBoolean": true, "id": "Group.actual", "path": "Group.actual" }, { "id": "Group.code", "max": "0", "path": "Group.code" }, { "id": "Group.quantity", "max": "0", "path": "Group.quantity" }, { "id": "Group.managingEntity", "min": 1, "path": "Group.managingEntity", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Group.characteristic", "max": "0", "path": "Group.characteristic" }, { "id": "Group.member", "min": 1, "path": "Group.member" }, { "id": "Group.member.entity", "path": "Group.member.entity", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Group.member.inactive", "min": 1, "path": "Group.member.inactive" } ] }, "fhirVersion": "4.0.1", "id": "GroupOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" } ], "meta": { "lastUpdated": "2024-04-12T17:46:21.858781+00:00", "versionId": "MTcxMjk0Mzk4MTg1ODc4MTAwMA" }, "name": "GroupOH", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Group" }, "comment": "If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" }, { "expression": "member.empty() or (actual = true)", "human": "Can only have members if group is \"actual\"", "key": "grp-1", "severity": "error", "xpath": "f:actual/@value=true() or not(exists(f:member))" } ], "definition": "Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.", "id": "Group", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]" } ], "max": "*", "min": 0, "path": "Group", "short": "Group of multiple entities" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Group.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Group.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Group.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Group.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Group.implicitRules", "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, "max": "1", "min": 0, "path": "Group.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Group.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Group.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Group.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Group.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Group.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Group.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Group.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Group.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Group.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Group.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Group.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A unique business identifier for this group.", "id": "Group.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": "unique(./id[displayable=\"true\" and scope=\"OBJ\"])" } ], "max": "1", "min": 1, "path": "Group.identifier", "requirements": "Allows the group to be referenced from external specifications.", "short": "Unique id", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Group.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Group.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Group.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Group.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "Group.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "Group.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "Group.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "Group.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "Group.identifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 1, "path": "Group.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "example": [ { "label": "General", "valueString": "123456" } ], "id": "Group.identifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Group.identifier.value", "short": "The value that is unique", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "Group.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Group.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "Group.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 0, "path": "Group.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Group.active" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates whether the record for the group is available for use or is merely being retained for historical purposes.", "id": "Group.active", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": "./statusCode" } ], "max": "1", "meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element", "min": 0, "path": "Group.active", "requirements": "Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists).", "short": "Whether this group's record is in active use", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 1, "path": "Group.type" }, "binding": { "description": "Types of resources that are part of group.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GroupType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/group-type|4.0.1" }, "comment": "Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medication or Substance for the other types.).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the broad classification of the kind of resources the group includes.", "fixedCode": "person", "id": "Group.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": "person: ./classCode=\"PSN\" animal: ./classCode=\"ANM\" device: ./classCode=\"DEV\" medication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"] food: ./classCode=\"FOOD\"" } ], "max": "1", "min": 1, "path": "Group.type", "requirements": "Identifies what type of resources the group is made up of.", "short": "person | animal | practitioner | device | medication | substance", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Group.actual" }, "condition": [ "grp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.", "fixedBoolean": true, "id": "Group.actual", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": "true: ./determinerCode=\"GRP\" false: ./determinerCode=\"GRP_KIND\"" } ], "max": "1", "min": 1, "path": "Group.actual", "requirements": "There are use-cases for groups that define specific collections of individuals, and other groups that define \"types\" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag.", "short": "Descriptive or actual", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "Group.code" }, "binding": { "description": "Kind of particular resource; e.g. cow, syringe, lake, etc.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GroupKind" } ], "strength": "example" }, "comment": "This would generally be omitted for Person resources.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides a specific type of resource the group includes; e.g. \"cow\", \"syringe\", etc.", "id": "Group.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "rim", "map": "./code" } ], "max": "0", "min": 0, "path": "Group.code", "short": "Kind of Group members", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Group.name" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A label assigned to the group for human identification and communication.", "id": "Group.name", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "./name[type=\"ST\"]" } ], "max": "1", "min": 0, "path": "Group.name", "requirements": "Used to identify the group in human communication.", "short": "Label for Group", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Group.quantity" }, "comment": "Note that the quantity may be less than the number of members if some of the members are not active.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A count of the number of resource instances that are part of the group.", "id": "Group.quantity", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "./quantity" } ], "max": "0", "min": 0, "path": "Group.quantity", "requirements": "Group size is a common defining characteristic.", "short": "Number of members", "type": [ { "code": "unsignedInt" } ] }, { "base": { "max": "1", "min": 0, "path": "Group.managingEntity" }, "comment": "This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Entity responsible for defining and maintaining Group characteristics and/or registered members.", "id": "Group.managingEntity", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Group.managingEntity", "short": "Entity that is the custodian of the Group's definition", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Group.characteristic" }, "comment": "All the identified characteristics must be true for an entity to a member of the group.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies traits whose presence r absence is shared by members of the group.", "id": "Group.characteristic", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]" } ], "max": "0", "min": 0, "path": "Group.characteristic", "requirements": "Needs to be a generic mechanism for identifying what individuals can be part of a group.", "short": "Include / Exclude group members by Trait", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Group.characteristic.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Group.characteristic.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Group.characteristic.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Group.characteristic.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Group.characteristic.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Group.characteristic.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Group.characteristic.code" }, "binding": { "description": "List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GroupCharacteristicKind" } ], "strength": "example" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that identifies the kind of trait being asserted.", "id": "Group.characteristic.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./code" } ], "max": "1", "min": 1, "path": "Group.characteristic.code", "requirements": "Need a formal way of identifying the characteristic being described.", "short": "Kind of characteristic", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 1, "path": "Group.characteristic.value[x]" }, "binding": { "description": "Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GroupCharacteristicValue" } ], "strength": "example" }, "comment": "For Range, it means members of the group have a value that falls somewhere within the specified range.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The value of the trait that holds (or does not hold - see 'exclude') for members of the group.", "id": "Group.characteristic.value[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./value" } ], "max": "1", "min": 1, "path": "Group.characteristic.value[x]", "requirements": "The value of the characteristic is what determines group membership.", "short": "Value held by characteristic", "type": [ { "code": "CodeableConcept" }, { "code": "boolean" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Reference" } ] }, { "base": { "max": "1", "min": 1, "path": "Group.characteristic.exclude" }, "comment": "This is labeled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If true, indicates the characteristic is one that is NOT held by members of the group.", "id": "Group.characteristic.exclude", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./valueNegationInd" } ], "max": "1", "min": 1, "path": "Group.characteristic.exclude", "requirements": "Sometimes group membership is determined by characteristics not possessed.", "short": "Group includes or excludes", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "Group.characteristic.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.", "id": "Group.characteristic.period", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Group.characteristic.period", "short": "Period over which characteristic is tested", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "Group.member" }, "condition": [ "grp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the resource instances that are members of the group.", "id": "Group.member", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./scopedRole[isNormalRole() and classCode=\"MBR\"]/player" } ], "max": "*", "min": 1, "path": "Group.member", "requirements": "Often the only thing of interest about a group is \"who's in it\".", "short": "Who or what is in group", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Group.member.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Group.member.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Group.member.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Group.member.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Group.member.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Group.member.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Group.member.entity" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.", "id": "Group.member.entity", "isModifier": false, "isSummary": false, "max": "1", "min": 1, "path": "Group.member.entity", "short": "Reference to the group member", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Group.member.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The period that the member was in the group, if known.", "id": "Group.member.period", "isModifier": false, "isSummary": false, "max": "1", "meaningWhenMissing": "The member is in the group at this time", "min": 0, "path": "Group.member.period", "requirements": "Need to track who was in a group at a particular time.", "short": "Period member belonged to the group", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Group.member.inactive" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A flag to indicate that the member is no longer in the group, but previously may have been a member.", "id": "Group.member.inactive", "isModifier": false, "isSummary": false, "max": "1", "meaningWhenMissing": "Members are considered active unless explicitly specified otherwise", "min": 1, "path": "Group.member.inactive", "requirements": "Sometimes you don't know when someone stopped being in a group, but not when.", "short": "If member is no longer in group", "type": [ { "code": "boolean" } ] } ] }, "status": "draft", "title": "OneHealth Group", "type": "Group", "url": "https://fhir.onehealth.com.pe/StructureDefinition/GroupOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/GoalOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Goal", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR GoalOH Profile, for OH interoperability scenarios, based on the national CORE Goal Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Goal.identifier", "max": "1", "min": 1, "path": "Goal.identifier" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings" }, "id": "Goal.achievementStatus", "path": "Goal.achievementStatus" }, { "id": "Goal.achievementStatus.coding.id", "max": "0", "path": "Goal.achievementStatus.coding.id" }, { "id": "Goal.achievementStatus.coding.system", "min": 1, "path": "Goal.achievementStatus.coding.system" }, { "id": "Goal.achievementStatus.coding.version", "max": "0", "path": "Goal.achievementStatus.coding.version" }, { "id": "Goal.achievementStatus.coding.code", "min": 1, "path": "Goal.achievementStatus.coding.code" }, { "id": "Goal.achievementStatus.coding.display", "min": 1, "path": "Goal.achievementStatus.coding.display" }, { "id": "Goal.achievementStatus.coding.userSelected", "max": "0", "path": "Goal.achievementStatus.coding.userSelected" }, { "id": "Goal.achievementStatus.text", "max": "0", "path": "Goal.achievementStatus.text" }, { "id": "Goal.category", "max": "0", "path": "Goal.category" }, { "id": "Goal.priority", "max": "0", "path": "Goal.priority" }, { "id": "Goal.description.coding.id", "max": "0", "path": "Goal.description.coding.id" }, { "id": "Goal.description.coding.system", "min": 1, "path": "Goal.description.coding.system" }, { "id": "Goal.description.coding.version", "max": "0", "path": "Goal.description.coding.version" }, { "id": "Goal.description.coding.code", "min": 1, "path": "Goal.description.coding.code" }, { "id": "Goal.description.coding.display", "min": 1, "path": "Goal.description.coding.display" }, { "id": "Goal.description.coding.userSelected", "max": "0", "path": "Goal.description.coding.userSelected" }, { "id": "Goal.subject", "path": "Goal.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Goal.start[x]", "path": "Goal.start[x]", "type": [ { "code": "date" } ] }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "id": "Goal.target.measure", "path": "Goal.target.measure" }, { "id": "Goal.target.measure.coding.id", "max": "0", "path": "Goal.target.measure.coding.id" }, { "id": "Goal.target.measure.coding.system", "min": 1, "path": "Goal.target.measure.coding.system" }, { "id": "Goal.target.measure.coding.version", "max": "0", "path": "Goal.target.measure.coding.version" }, { "id": "Goal.target.measure.coding.code", "min": 1, "path": "Goal.target.measure.coding.code" }, { "id": "Goal.target.measure.coding.display", "min": 1, "path": "Goal.target.measure.coding.display" }, { "id": "Goal.target.measure.coding.userSelected", "max": "0", "path": "Goal.target.measure.coding.userSelected" }, { "id": "Goal.expressedBy", "path": "Goal.expressedBy", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "Goal.addresses", "path": "Goal.addresses", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH", "https://fhir.onehealth.com.pe/StructureDefinition/ConditionProblemListItemOH", "https://fhir.onehealth.com.pe/StructureDefinition/ServiceRequestOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "id": "Goal.outcomeCode", "path": "Goal.outcomeCode" }, { "id": "Goal.outcomeCode.coding.id", "max": "0", "path": "Goal.outcomeCode.coding.id" }, { "id": "Goal.outcomeCode.coding.system", "min": 1, "path": "Goal.outcomeCode.coding.system" }, { "id": "Goal.outcomeCode.coding.version", "max": "0", "path": "Goal.outcomeCode.coding.version" }, { "id": "Goal.outcomeCode.coding.code", "min": 1, "path": "Goal.outcomeCode.coding.code" }, { "id": "Goal.outcomeCode.coding.display", "min": 1, "path": "Goal.outcomeCode.coding.display" }, { "id": "Goal.outcomeCode.coding.userSelected", "max": "0", "path": "Goal.outcomeCode.coding.userSelected" }, { "id": "Goal.outcomeReference", "max": "0", "path": "Goal.outcomeReference" } ] }, "fhirVersion": "4.0.1", "id": "GoalOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" } ], "meta": { "lastUpdated": "2024-04-12T17:46:21.65379+00:00", "versionId": "MTcxMjk0Mzk4MTY1Mzc5MDAwMA" }, "name": "GoalOH", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Goal" }, "comment": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.", "id": "Goal", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "GOL.1" }, { "identity": "rim", "map": ".outboundRelationship[typeCode<=OBJ]." } ], "max": "*", "min": 0, "path": "Goal", "short": "Describes the intended objective(s) for a patient, group or organization" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Goal.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Goal.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Goal.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Goal.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Goal.implicitRules", "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, "max": "1", "min": 0, "path": "Goal.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Goal.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Goal.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Goal.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Goal.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Goal.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Goal.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Goal.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Goal.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Goal.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Goal.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Goal.identifier" }, "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 a Person resource instance might share the same social insurance number.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", "id": "Goal.identifier", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": ".id" } ], "max": "1", "min": 1, "path": "Goal.identifier", "requirements": "Allows identification of the goal as it is known by various participating systems and in a way that remains consistent across servers.", "short": "External Ids for this goal", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 1, "path": "Goal.lifecycleStatus" }, "binding": { "description": "Codes that reflect the current state of a goal and whether the goal is still being targeted.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalLifecycleStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/goal-status|4.0.1" }, "comment": "This element is labeled as a modifier because the lifecycleStatus contains codes that mark the resource as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The state of the goal throughout its lifecycle.", "id": "Goal.lifecycleStatus", "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, "mapping": [ { "identity": "w5", "map": "FiveWs.status" }, { "identity": "v2", "map": "GOL-18-goal life cycle status" }, { "identity": "rim", "map": ".statusCode in-progress = active (classCode = OBJ) cancelled = aborted" } ], "max": "1", "min": 1, "path": "Goal.lifecycleStatus", "requirements": "Allows knowing whether goal needs to be further tracked.", "short": "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Goal.achievementStatus" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes the progression, or lack thereof, towards the goal against the target.", "id": "Goal.achievementStatus", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".statusCode achieved = complete sustaining = active" } ], "max": "1", "min": 0, "path": "Goal.achievementStatus", "short": "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Goal.achievementStatus.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Goal.achievementStatus.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Goal.achievementStatus.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Goal.achievementStatus.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Goal.achievementStatus.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Goal.achievementStatus.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Goal.achievementStatus.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Goal.achievementStatus.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Goal.achievementStatus.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Goal.achievementStatus.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Goal.achievementStatus.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Goal.achievementStatus.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Goal.achievementStatus.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Goal.achievementStatus.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Goal.achievementStatus.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Goal.achievementStatus.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Goal.achievementStatus.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Goal.achievementStatus.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Goal.achievementStatus.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Goal.achievementStatus.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Goal.achievementStatus.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Goal.achievementStatus.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Goal.category" }, "binding": { "description": "Codes for grouping and sorting goals.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalCategory" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/goal-category" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates a category the goal falls within.", "id": "Goal.category", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" } ], "max": "0", "min": 0, "path": "Goal.category", "requirements": "Allows goals to be filtered and sorted.", "short": "E.g. Treatment, dietary, behavioral, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Goal.priority" }, "binding": { "description": "The level of importance associated with a goal.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalPriority" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/goal-priority" }, "comment": "Extensions are available to track priorities as established by each participant (i.e. Priority from the patient's perspective, different practitioners' perspectives, family member's perspectives)\r\rThe ordinal extension on Coding can be used to convey a numerically comparable ranking to priority. (Keep in mind that different coding systems may use a \"low value=important\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.", "id": "Goal.priority", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.grade" }, { "identity": "rim", "map": ".priorityCode" } ], "max": "0", "min": 0, "path": "Goal.priority", "requirements": "Used for sorting and presenting goals.", "short": "high-priority | medium-priority | low-priority", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 1, "path": "Goal.description" }, "binding": { "description": "Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalDescription" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings" }, "comment": "If no code is available, use CodeableConcept.text.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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\".", "id": "Goal.description", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "v2", "map": "GOL-3.2-goal ID.text" }, { "identity": "rim", "map": ".text" } ], "max": "1", "min": 1, "path": "Goal.description", "requirements": "Without a description of what's trying to be achieved, element has no purpose.", "short": "Code or text describing goal", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Goal.description.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Goal.description.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Goal.description.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Goal.description.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Goal.description.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Goal.description.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Goal.description.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Goal.description.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Goal.description.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Goal.description.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Goal.description.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Goal.description.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Goal.description.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Goal.description.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Goal.description.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Goal.description.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Goal.description.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Goal.description.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Goal.description.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Goal.description.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Goal.description.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "Goal.description.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 1, "path": "Goal.subject" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the patient, group or organization for whom the goal is being established.", "id": "Goal.subject", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "v2", "map": "PID-3-patient ID list" }, { "identity": "rim", "map": ".participation[typeCode=PAT].role[classCode=PAT]" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 1, "path": "Goal.subject", "requirements": "Subject is optional to support annonymized reporting.", "short": "Who this goal is intended for", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Goal.start[x]" }, "binding": { "description": "Codes describing events that can trigger the initiation of a goal.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalStartEvent" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/goal-start-event" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date or event after which the goal should begin being pursued.", "id": "Goal.start[x]", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.planned" } ], "max": "1", "min": 0, "path": "Goal.start[x]", "requirements": "Goals can be established prior to there being an intention to start pursuing them; e.g. Goals for post-surgical recovery established prior to surgery.", "short": "When goal pursuit begins", "type": [ { "code": "date" } ] }, { "base": { "max": "*", "min": 0, "path": "Goal.target" }, "comment": "When multiple targets are present for a single goal instance, all targets must be met for the overall goal to be met.", "condition": [ "gol-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "(detail.exists() and measure.exists()) or detail.exists().not()", "human": "Goal.target.measure is required if Goal.target.detail is populated", "key": "gol-1", "severity": "error", "xpath": "(exists(f:*[starts-with(local-name(.), 'detail')]) and exists(f:measure)) or not(exists(f:*[starts-with(local-name(.), 'detail')]))" } ], "definition": "Indicates what should be done by when.", "id": "Goal.target", "isModifier": false, "isSummary": false, "max": "*", "min": 0, "path": "Goal.target", "requirements": "Allows the progress of the goal to be monitored against an observation or due date. Target is 0..* to support Observations with multiple components, such as blood pressure goals with both a systolic and diastolic target.", "short": "Target outcome for the goal", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Goal.target.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Goal.target.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Goal.target.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Goal.target.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Goal.target.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Goal.target.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Goal.target.measure" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "condition": [ "gol-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.", "id": "Goal.target.measure", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Goal.target.measure", "short": "The parameter whose value is being tracked", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Goal.target.measure.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Goal.target.measure.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Goal.target.measure.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Goal.target.measure.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Goal.target.measure.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Goal.target.measure.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Goal.target.measure.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Goal.target.measure.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Goal.target.measure.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Goal.target.measure.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Goal.target.measure.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Goal.target.measure.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Goal.target.measure.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Goal.target.measure.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Goal.target.measure.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Goal.target.measure.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Goal.target.measure.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Goal.target.measure.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Goal.target.measure.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Goal.target.measure.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Goal.target.measure.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "Goal.target.measure.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Goal.target.detail[x]" }, "binding": { "description": "Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalTargetDetail" } ], "strength": "example" }, "comment": "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 Goal.target.measure defines a coded value.", "condition": [ "gol-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.", "id": "Goal.target.detail[x]", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Goal.target.detail[x]", "short": "The target value to be achieved", "type": [ { "code": "Quantity" }, { "code": "Range" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Ratio" } ] }, { "base": { "max": "1", "min": 0, "path": "Goal.target.due[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates either the date or the duration after start by which the goal should be met.", "id": "Goal.target.due[x]", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.done[x]" } ], "max": "1", "min": 0, "path": "Goal.target.due[x]", "requirements": "Identifies when the goal should be evaluated.", "short": "Reach goal on or before", "type": [ { "code": "date" }, { "code": "Duration" } ] }, { "base": { "max": "1", "min": 0, "path": "Goal.statusDate" }, "comment": "To see the date for past statuses, query history.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.", "id": "Goal.statusDate", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.recorded" } ], "max": "1", "min": 0, "path": "Goal.statusDate", "short": "When goal status took effect", "type": [ { "code": "date" } ] }, { "base": { "max": "1", "min": 0, "path": "Goal.statusReason" }, "comment": "This will typically be captured for statuses such as rejected, on-hold or cancelled, but could be present for others.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Captures the reason for the current status.", "id": "Goal.statusReason", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Goal.statusReason", "short": "Reason for current status", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Goal.expressedBy" }, "comment": "This is the individual responsible for establishing the goal, not necessarily who recorded it. (For that, use the Provenance resource.).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates whose goal this is - patient goal, practitioner goal, etc.", "id": "Goal.expressedBy", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.source" } ], "max": "1", "min": 0, "path": "Goal.expressedBy", "short": "Who's responsible for creating Goal?", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Goal.addresses" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identified conditions and other health record elements that are intended to be addressed by the goal.", "id": "Goal.addresses", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=SUBJ].target[classCode=CONC]" } ], "max": "*", "min": 0, "path": "Goal.addresses", "requirements": "Allows specific goals to explicitly linked to the concerns they're dealing with - makes the goal more understandable.", "short": "Issues addressed by this goal", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH", "https://fhir.onehealth.com.pe/StructureDefinition/ConditionProblemListItemOH", "https://fhir.onehealth.com.pe/StructureDefinition/ServiceRequestOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Goal.note" }, "comment": "May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Any comments related to the goal.", "id": "Goal.note", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "GOL-16-goal evaluation + NTE?" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" } ], "max": "*", "min": 0, "path": "Goal.note", "requirements": "There's a need to capture information about the goal that doesn't actually describe the goal.", "short": "Comments about the goal", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "*", "min": 0, "path": "Goal.outcomeCode" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes" }, "comment": "Note that this should not duplicate the goal status.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the change (or lack of change) at the point when the status of the goal is assessed.", "id": "Goal.outcomeCode", "isModifier": false, "isSummary": false, "max": "*", "min": 0, "path": "Goal.outcomeCode", "requirements": "Outcome tracking is a key aspect of care planning.", "short": "What result was achieved regarding the goal?", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Goal.outcomeCode.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Goal.outcomeCode.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Goal.outcomeCode.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Goal.outcomeCode.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Goal.outcomeCode.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Goal.outcomeCode.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Goal.outcomeCode.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Goal.outcomeCode.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Goal.outcomeCode.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Goal.outcomeCode.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Goal.outcomeCode.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Goal.outcomeCode.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Goal.outcomeCode.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Goal.outcomeCode.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Goal.outcomeCode.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Goal.outcomeCode.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Goal.outcomeCode.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Goal.outcomeCode.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Goal.outcomeCode.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Goal.outcomeCode.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Goal.outcomeCode.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "Goal.outcomeCode.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Goal.outcomeReference" }, "comment": "The goal outcome is independent of the outcome of the related activities. For example, if the Goal is to achieve a target body weight of 150 lb and a care plan activity is defined to diet, then the care plan’s activity outcome could be calories consumed whereas goal outcome is an observation for the actual body weight measured.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Details of what's changed (or not changed).", "id": "Goal.outcomeReference", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "Goal.outcomeReference", "requirements": "Outcome tracking is a key aspect of care planning.", "short": "Observation that resulted from goal", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation" ] } ] } ] }, "status": "draft", "title": "OneHealth Goal", "type": "Goal", "url": "https://fhir.onehealth.com.pe/StructureDefinition/GoalOH", "version": "2.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/Extension-ServiceType", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "context": [ { "expression": "Person", "type": "element" } ], "copyright": "Zentricx 2023+", "date": "2023-10-30", "derivation": "constraint", "description": "The extension used in the Patient.name.family and Practitioner.name.family element to record the person's second (or mother's) family name..", "differential": { "element": [ { "definition": "The extension used in the Encounter and Appointment element to record the specific service that is to be performed during this appointment.", "id": "Extension", "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "The specific service that is to be performed during this appointment" }, { "id": "Extension.id", "path": "Extension.id", "patternString": "Extension_ServiceType" }, { "id": "Extension.extension", "max": "0", "path": "Extension.extension" }, { "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-ServiceType", "id": "Extension.url", "path": "Extension.url" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/HealthcareServiceOH" ] } ] } ] }, "fhirVersion": "4.0.1", "id": "Extension-ServiceType", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "complex-type", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" } ], "meta": { "lastUpdated": "2024-04-12T17:46:21.383786+00:00", "versionId": "MTcxMjk0Mzk4MTM4Mzc4NjAwMA" }, "name": "Extension_ServiceType", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Extension" }, "condition": [ "ele-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "definition": "The extension used in the Encounter and Appointment element to record the specific service that is to be performed during this appointment.", "id": "Extension", "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "The specific service that is to be performed during this appointment" }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Extension.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Extension.id", "patternString": "Extension_ServiceType", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Extension.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Extension.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Extension.url" }, "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "definition": "Source of the definition for the extension code - a logical name or a URL.", "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-ServiceType", "id": "Extension.url", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Extension.value[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "id": "Extension.value[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Extension.value[x]", "short": "Value of extension", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/HealthcareServiceOH" ] } ] } ] }, "status": "draft", "title": "Extension: ServiceType", "type": "Extension", "url": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-ServiceType", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/Extension-Religion", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "context": [ { "expression": "Patient", "type": "element" } ], "copyright": "Zentricx 2023+", "date": "2023-10-30", "derivation": "constraint", "description": "Extension used in patient to refer to religion", "differential": { "element": [ { "definition": "Extension used in patient to refer to religion.", "id": "Extension", "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Patient religion" }, { "id": "Extension.extension", "max": "0", "path": "Extension.extension" }, { "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-Religion", "id": "Extension.url", "path": "Extension.url" }, { "definition": "catolicismo | evangelismo | no informa", "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "catolicismo | evangelismo | no informa", "type": [ { "code": "code" } ] } ] }, "fhirVersion": "4.0.1", "id": "Extension-Religion", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "complex-type", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" } ], "meta": { "lastUpdated": "2024-04-12T17:46:21.259653+00:00", "versionId": "MTcxMjk0Mzk4MTI1OTY1MzAwMA" }, "name": "Extension_Religion", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Extension" }, "condition": [ "ele-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "definition": "Extension used in patient to refer to religion.", "id": "Extension", "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Patient religion" }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Extension.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Extension.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Extension.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Extension.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Extension.url" }, "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "definition": "Source of the definition for the extension code - a logical name or a URL.", "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-Religion", "id": "Extension.url", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Extension.value[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "catolicismo | evangelismo | no informa", "id": "Extension.value[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Extension.value[x]", "short": "catolicismo | evangelismo | no informa", "type": [ { "code": "code" } ] } ] }, "status": "draft", "title": "Extension: Religion", "type": "Extension", "url": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-Religion", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/Extension-Province", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "context": [ { "expression": "Person", "type": "element" } ], "copyright": "Zentricx 2023+", "date": "2023-10-30", "derivation": "constraint", "description": "Extension used in person to reference province.", "differential": { "element": [ { "definition": "Extension used in to record the province.", "id": "Extension", "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Perú province" }, { "id": "Extension.extension", "max": "0", "path": "Extension.extension" }, { "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-province", "id": "Extension.url", "path": "Extension.url" }, { "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/UbigeoReniecProvincesOH" }, "id": "Extension.value[x]", "path": "Extension.value[x]", "type": [ { "code": "Coding" } ] } ] }, "fhirVersion": "4.0.1", "id": "Extension-Province", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "complex-type", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" } ], "meta": { "lastUpdated": "2024-04-12T17:46:21.123628+00:00", "versionId": "MTcxMjk0Mzk4MTEyMzYyODAwMA" }, "name": "Extension_Province", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Extension" }, "condition": [ "ele-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "definition": "Extension used in to record the province.", "id": "Extension", "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Perú province" }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Extension.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Extension.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Extension.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Extension.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Extension.url" }, "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "definition": "Source of the definition for the extension code - a logical name or a URL.", "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-province", "id": "Extension.url", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Extension.value[x]" }, "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/UbigeoReniecProvincesOH" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "id": "Extension.value[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Extension.value[x]", "short": "Value of extension", "type": [ { "code": "Coding" } ] } ] }, "status": "draft", "title": "Extension: Province", "type": "Extension", "url": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-province", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/Extension-MothersFamilyName", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "context": [ { "expression": "Person", "type": "element" } ], "copyright": "Zentricx 2023+", "date": "2023-10-30", "derivation": "constraint", "description": "The extension used in the Patient.name.family and Practitioner.name.family element to record the person's second (or mother's) family name..", "differential": { "element": [ { "definition": "The extension used in the Person.name.family element to record the person's second (or mother's) family name.", "id": "Extension", "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Person second family name" }, { "id": "Extension.id", "path": "Extension.id", "patternString": "Extension_MothersFamilyName" }, { "id": "Extension.extension", "max": "0", "path": "Extension.extension" }, { "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-MothersFamilyName", "id": "Extension.url", "path": "Extension.url" }, { "id": "Extension.value[x]", "min": 1, "mustSupport": true, "path": "Extension.value[x]", "type": [ { "code": "string" } ] } ] }, "fhirVersion": "4.0.1", "id": "Extension-MothersFamilyName", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "complex-type", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" } ], "meta": { "lastUpdated": "2024-04-12T17:46:20.998603+00:00", "versionId": "MTcxMjk0Mzk4MDk5ODYwMzAwMA" }, "name": "Extension_MothersFamilyName", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Extension" }, "condition": [ "ele-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "definition": "The extension used in the Person.name.family element to record the person's second (or mother's) family name.", "id": "Extension", "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Person second family name" }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Extension.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Extension.id", "patternString": "Extension_MothersFamilyName", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Extension.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Extension.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Extension.url" }, "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "definition": "Source of the definition for the extension code - a logical name or a URL.", "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-MothersFamilyName", "id": "Extension.url", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Extension.value[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "id": "Extension.value[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Extension.value[x]", "short": "Value of extension", "type": [ { "code": "string" } ] } ] }, "status": "draft", "title": "Extension: MothersFamilyName", "type": "Extension", "url": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-MothersFamilyName", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/Extension-MPIState", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "context": [ { "expression": "Person", "type": "element" } ], "copyright": "Zentricx 2023+", "date": "2023-10-30", "derivation": "constraint", "description": "The extension used in the Person element to record the person's Master Person Index (MPI) state.", "differential": { "element": [ { "definition": "The extension used in the Person element to record the person's MPI State.", "id": "Extension", "max": "1", "path": "Extension", "short": "Person Master Person Index (MPI) State" }, { "id": "Extension.id", "path": "Extension.id", "patternString": "Extension_MPIState" }, { "id": "Extension.extension", "max": "0", "path": "Extension.extension" }, { "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-MPIState", "id": "Extension.url", "path": "Extension.url" }, { "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/MPIStateValueSetOH" }, "id": "Extension.value[x]", "path": "Extension.value[x]", "type": [ { "code": "code" } ] } ] }, "fhirVersion": "4.0.1", "id": "Extension-MPIState", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "complex-type", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" } ], "meta": { "lastUpdated": "2024-04-12T17:46:20.878593+00:00", "versionId": "MTcxMjk0Mzk4MDg3ODU5MzAwMA" }, "name": "Extension_MPIState", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Extension" }, "condition": [ "ele-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "definition": "The extension used in the Person element to record the person's MPI State.", "id": "Extension", "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Extension", "short": "Person Master Person Index (MPI) State" }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Extension.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Extension.id", "patternString": "Extension_MPIState", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Extension.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Extension.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Extension.url" }, "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "definition": "Source of the definition for the extension code - a logical name or a URL.", "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-MPIState", "id": "Extension.url", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Extension.value[x]" }, "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/MPIStateValueSetOH" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "id": "Extension.value[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Extension.value[x]", "short": "Value of extension", "type": [ { "code": "code" } ] } ] }, "status": "draft", "title": "Extension: MPIState", "type": "Extension", "url": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-MPIState", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/Extension-FathersFamilyName", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "context": [ { "expression": "Person", "type": "element" } ], "copyright": "Zentricx 2023+", "date": "2023-10-30", "derivation": "constraint", "description": "Extension used in the Patient.name.family and Practitioner.name.family element to record the person's first (or paternal) family name.", "differential": { "element": [ { "definition": "Extension used in the Person.name.family to record the person's first (or paternal) family name.", "id": "Extension", "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Person first family name" }, { "id": "Extension.extension", "max": "0", "path": "Extension.extension" }, { "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-FathersFamilyName", "id": "Extension.url", "path": "Extension.url" }, { "id": "Extension.value[x]", "min": 1, "mustSupport": true, "path": "Extension.value[x]", "type": [ { "code": "string" } ] } ] }, "fhirVersion": "4.0.1", "id": "Extension-FathersFamilyName", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "complex-type", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" } ], "meta": { "lastUpdated": "2024-04-12T17:46:20.749433+00:00", "versionId": "MTcxMjk0Mzk4MDc0OTQzMzAwMA" }, "name": "Extension_FathersFamilyName", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Extension" }, "condition": [ "ele-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "definition": "Extension used in the Person.name.family to record the person's first (or paternal) family name.", "id": "Extension", "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Person first family name" }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Extension.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Extension.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Extension.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Extension.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Extension.url" }, "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "definition": "Source of the definition for the extension code - a logical name or a URL.", "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-FathersFamilyName", "id": "Extension.url", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Extension.value[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "id": "Extension.value[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Extension.value[x]", "short": "Value of extension", "type": [ { "code": "string" } ] } ] }, "status": "draft", "title": "Extension: FathersFamilyName", "type": "Extension", "url": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-FathersFamilyName", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/Extension-District", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "context": [ { "expression": "Person", "type": "element" } ], "copyright": "Zentricx 2023+", "date": "2023-10-30", "derivation": "constraint", "description": "Extension used in person to reference district.", "differential": { "element": [ { "definition": "Extension used to record the district.", "id": "Extension", "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Perú District" }, { "id": "Extension.extension", "max": "0", "path": "Extension.extension" }, { "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-district", "id": "Extension.url", "path": "Extension.url" }, { "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/UbigeoReniecDistrictsOH" }, "id": "Extension.value[x]", "path": "Extension.value[x]", "type": [ { "code": "Coding" } ] } ] }, "fhirVersion": "4.0.1", "id": "Extension-District", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "complex-type", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" } ], "meta": { "lastUpdated": "2024-04-12T17:46:20.605051+00:00", "versionId": "MTcxMjk0Mzk4MDYwNTA1MTAwMA" }, "name": "Extension_District", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Extension" }, "condition": [ "ele-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "definition": "Extension used to record the district.", "id": "Extension", "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Perú District" }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Extension.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Extension.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Extension.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Extension.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Extension.url" }, "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "definition": "Source of the definition for the extension code - a logical name or a URL.", "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-district", "id": "Extension.url", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Extension.value[x]" }, "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/UbigeoReniecDistrictsOH" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "id": "Extension.value[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Extension.value[x]", "short": "Value of extension", "type": [ { "code": "Coding" } ] } ] }, "status": "draft", "title": "Extension: District", "type": "Extension", "url": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-district", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/Extension-Department", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "context": [ { "expression": "Person", "type": "element" } ], "copyright": "Zentricx 2023+", "date": "2023-10-30", "derivation": "constraint", "description": "Extension used in person to reference department.", "differential": { "element": [ { "definition": "Extension used in the to record the department.", "id": "Extension", "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Perú Department" }, { "id": "Extension.extension", "max": "0", "path": "Extension.extension" }, { "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-department", "id": "Extension.url", "path": "Extension.url" }, { "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/UbigeoReniecDepartmentsOH" }, "id": "Extension.value[x]", "path": "Extension.value[x]", "type": [ { "code": "Coding" } ] } ] }, "fhirVersion": "4.0.1", "id": "Extension-Department", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "complex-type", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" } ], "meta": { "lastUpdated": "2024-04-12T17:46:20.479527+00:00", "versionId": "MTcxMjk0Mzk4MDQ3OTUyNzAwMA" }, "name": "Extension_Department", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Extension" }, "condition": [ "ele-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "definition": "Extension used in the to record the department.", "id": "Extension", "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Perú Department" }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Extension.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Extension.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Extension.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Extension.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Extension.url" }, "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "definition": "Source of the definition for the extension code - a logical name or a URL.", "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-department", "id": "Extension.url", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Extension.value[x]" }, "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/UbigeoReniecDepartmentsOH" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "id": "Extension.value[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Extension.value[x]", "short": "Value of extension", "type": [ { "code": "Coding" } ] } ] }, "status": "draft", "title": "Extension: Department", "type": "Extension", "url": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-department", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/Extension-Classification", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "context": [ { "expression": "Patient", "type": "element" } ], "copyright": "Zentricx 2023+", "date": "2023-10-30", "derivation": "constraint", "description": "Extension used in patient to reference classification.", "differential": { "element": [ { "definition": "Extension used in the Patient to record the classification.", "id": "Extension", "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Patient classification" }, { "id": "Extension.extension", "max": "0", "path": "Extension.extension" }, { "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-Classification", "id": "Extension.url", "path": "Extension.url" }, { "definition": "vip | normal | sin clasificar", "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "vip | normal | sin clasificar", "type": [ { "code": "code" } ] } ] }, "fhirVersion": "4.0.1", "id": "Extension-Classification", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "complex-type", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" } ], "meta": { "lastUpdated": "2024-04-12T17:46:20.33485+00:00", "versionId": "MTcxMjk0Mzk4MDMzNDg1MDAwMA" }, "name": "Extension_Classification", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Extension" }, "condition": [ "ele-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "definition": "Extension used in the Patient to record the classification.", "id": "Extension", "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Patient classification" }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Extension.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Extension.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Extension.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Extension.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Extension.url" }, "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "definition": "Source of the definition for the extension code - a logical name or a URL.", "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-Classification", "id": "Extension.url", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Extension.value[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "vip | normal | sin clasificar", "id": "Extension.value[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Extension.value[x]", "short": "vip | normal | sin clasificar", "type": [ { "code": "code" } ] } ] }, "status": "draft", "title": "Extension: Classification", "type": "Extension", "url": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-Classification", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/Extension-AtentionForm", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "context": [ { "expression": "Patient", "type": "element" } ], "copyright": "Zentricx 2023+", "date": "2023-10-30", "derivation": "constraint", "description": "Extension used in appointment to reference Atention Form.", "differential": { "element": [ { "definition": "Extension used in the Patient to record the Atention Form.", "id": "Extension", "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Atention Form" }, { "id": "Extension.extension", "max": "0", "path": "Extension.extension" }, { "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-AtentionForm", "id": "Extension.url", "path": "Extension.url" }, { "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/AtentionFormValueSetOH" }, "definition": "V = 'Virtual' | P = 'Presencial'", "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "V = 'Virtual' | P = 'Presencial'", "type": [ { "code": "code" } ] } ] }, "fhirVersion": "4.0.1", "id": "Extension-AtentionForm", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "complex-type", "mapping": [ { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" } ], "meta": { "lastUpdated": "2024-04-12T17:46:20.208409+00:00", "versionId": "MTcxMjk0Mzk4MDIwODQwOTAwMA" }, "name": "Extension_AtentionForm", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Extension" }, "condition": [ "ele-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "definition": "Extension used in the Patient to record the Atention Form.", "id": "Extension", "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "mustSupport": true, "path": "Extension", "short": "Atention Form" }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Extension.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Extension.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Extension.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Extension.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Extension.url" }, "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "definition": "Source of the definition for the extension code - a logical name or a URL.", "fixedUri": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-AtentionForm", "id": "Extension.url", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 1, "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Extension.value[x]" }, "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/AtentionFormValueSetOH" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "V = 'Virtual' | P = 'Presencial'", "id": "Extension.value[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Extension.value[x]", "short": "V = 'Virtual' | P = 'Presencial'", "type": [ { "code": "code" } ] } ] }, "status": "draft", "title": "Extension: AtentionForm", "type": "Extension", "url": "https://fhir.onehealth.com.pe/StructureDefinition/Extension-AtentionForm", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/EncounterOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Encounter", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR EncounterOH Profile, for OH interoperability scenarios, based on the national CORE Encounter Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Encounter.extension", "path": "Encounter.extension", "slicing": { "discriminator": [ { "path": "url", "type": "value" } ], "ordered": false, "rules": "open" } }, { "id": "Encounter.extension:Extension_ServiceType", "max": "1", "min": 0, "path": "Encounter.extension", "short": "The specific service that is to be performed during this appointment", "sliceName": "Extension_ServiceType", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-ServiceType" ] } ] }, { "id": "Encounter.identifier", "max": "1", "min": 1, "path": "Encounter.identifier" }, { "id": "Encounter.identifier.use", "max": "0", "path": "Encounter.identifier.use" }, { "id": "Encounter.identifier.type", "max": "0", "path": "Encounter.identifier.type" }, { "id": "Encounter.identifier.system", "min": 1, "path": "Encounter.identifier.system" }, { "id": "Encounter.identifier.value", "min": 1, "path": "Encounter.identifier.value" }, { "id": "Encounter.identifier.period", "max": "0", "path": "Encounter.identifier.period" }, { "id": "Encounter.identifier.assigner", "min": 1, "path": "Encounter.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Encounter.statusHistory", "max": "0", "path": "Encounter.statusHistory" }, { "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode" }, "id": "Encounter.class.system", "min": 1, "path": "Encounter.class.system" }, { "id": "Encounter.class.version", "max": "0", "path": "Encounter.class.version" }, { "id": "Encounter.class.code", "min": 1, "path": "Encounter.class.code" }, { "id": "Encounter.class.display", "min": 1, "path": "Encounter.class.display" }, { "id": "Encounter.class.userSelected", "max": "0", "path": "Encounter.class.userSelected" }, { "id": "Encounter.classHistory", "max": "0", "path": "Encounter.classHistory" }, { "id": "Encounter.type", "max": "0", "path": "Encounter.type" }, { "id": "Encounter.serviceType", "max": "0", "path": "Encounter.serviceType" }, { "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/PrioritiesValueSetOH" }, "id": "Encounter.priority", "path": "Encounter.priority" }, { "id": "Encounter.priority.coding.system", "min": 1, "path": "Encounter.priority.coding.system", "patternUri": "https://fhir.onehealth.com.pe/CodeSystem/PrioritiesCodeSystemOH" }, { "id": "Encounter.priority.coding.version", "max": "0", "path": "Encounter.priority.coding.version" }, { "id": "Encounter.priority.coding.code", "min": 1, "path": "Encounter.priority.coding.code" }, { "id": "Encounter.priority.coding.display", "min": 1, "path": "Encounter.priority.coding.display" }, { "id": "Encounter.priority.coding.userSelected", "max": "0", "path": "Encounter.priority.coding.userSelected" }, { "id": "Encounter.priority.text", "max": "0", "path": "Encounter.priority.text" }, { "id": "Encounter.subject", "min": 1, "path": "Encounter.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Encounter.episodeOfCare", "max": "0", "path": "Encounter.episodeOfCare" }, { "id": "Encounter.basedOn", "path": "Encounter.basedOn", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ServiceRequestOH" ] } ] }, { "id": "Encounter.participant", "min": 1, "path": "Encounter.participant" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-participant-type" }, "id": "Encounter.participant.type.coding.system", "path": "Encounter.participant.type.coding.system" }, { "id": "Encounter.participant.type.coding.version", "max": "0", "path": "Encounter.participant.type.coding.version" }, { "id": "Encounter.participant.type.coding.userSelected", "max": "0", "path": "Encounter.participant.type.coding.userSelected" }, { "id": "Encounter.participant.type.text", "max": "0", "path": "Encounter.participant.type.text" }, { "id": "Encounter.participant.period", "max": "0", "path": "Encounter.participant.period" }, { "id": "Encounter.participant.individual", "min": 1, "path": "Encounter.participant.individual", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "Encounter.appointment", "path": "Encounter.appointment", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/AppointmentOH" ] } ] }, { "id": "Encounter.period", "min": 1, "path": "Encounter.period" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-reason" }, "id": "Encounter.reasonCode", "path": "Encounter.reasonCode" }, { "id": "Encounter.reasonCode.coding.version", "max": "0", "path": "Encounter.reasonCode.coding.version" }, { "id": "Encounter.reasonCode.coding.userSelected", "max": "0", "path": "Encounter.reasonCode.coding.userSelected" }, { "id": "Encounter.reasonCode.text", "max": "0", "path": "Encounter.reasonCode.text" }, { "id": "Encounter.reasonReference", "max": "0", "path": "Encounter.reasonReference" }, { "id": "Encounter.diagnosis.condition", "path": "Encounter.diagnosis.condition", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/diagnosis-role" }, "id": "Encounter.diagnosis.use", "path": "Encounter.diagnosis.use" }, { "id": "Encounter.diagnosis.use.coding.system", "min": 1, "path": "Encounter.diagnosis.use.coding.system" }, { "id": "Encounter.diagnosis.use.coding.version", "max": "0", "path": "Encounter.diagnosis.use.coding.version" }, { "id": "Encounter.diagnosis.use.coding.code", "min": 1, "path": "Encounter.diagnosis.use.coding.code" }, { "id": "Encounter.diagnosis.use.coding.userSelected", "max": "0", "path": "Encounter.diagnosis.use.coding.userSelected" }, { "id": "Encounter.diagnosis.use.text", "max": "0", "path": "Encounter.diagnosis.use.text" }, { "id": "Encounter.account", "max": "1", "path": "Encounter.account", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/AccountOH" ] } ] }, { "id": "Encounter.hospitalization", "max": "0", "path": "Encounter.hospitalization" }, { "id": "Encounter.location", "max": "1", "min": 1, "path": "Encounter.location" }, { "id": "Encounter.location.location", "path": "Encounter.location.location", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/LocationOH" ] } ] }, { "id": "Encounter.location.status", "max": "0", "path": "Encounter.location.status" }, { "id": "Encounter.location.physicalType", "max": "0", "path": "Encounter.location.physicalType" }, { "id": "Encounter.location.period", "max": "0", "path": "Encounter.location.period" }, { "id": "Encounter.serviceProvider", "min": 1, "path": "Encounter.serviceProvider", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Encounter.partOf", "max": "0", "path": "Encounter.partOf" } ] }, "fhirVersion": "4.0.1", "id": "EncounterOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" } ], "meta": { "lastUpdated": "2024-04-12T17:46:20.0328+00:00", "versionId": "MTcxMjk0Mzk4MDAzMjgwMDAwMA" }, "name": "EncounterOH", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Visit" ], "base": { "max": "*", "min": 0, "path": "Encounter" }, "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.", "id": "Encounter", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "rim", "map": "Encounter[@moodCode='EVN']" } ], "max": "*", "min": 0, "path": "Encounter", "short": "An interaction during which services are provided to the patient" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Encounter.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Encounter.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Encounter.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Encounter.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Encounter.implicitRules", "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, "max": "1", "min": 0, "path": "Encounter.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Encounter.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Encounter.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Encounter.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Encounter.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Encounter.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Encounter.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Encounter.extension", "short": "Additional content defined by implementations", "slicing": { "discriminator": [ { "path": "url", "type": "value" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.extension:Extension_ServiceType", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "1", "min": 0, "path": "Encounter.extension", "short": "The specific service that is to be performed during this appointment", "sliceName": "Extension_ServiceType", "type": [ { "code": "Extension", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/Extension-ServiceType" ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Encounter.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Encounter.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Encounter.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifier(s) by which this encounter is known.", "id": "Encounter.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "PV1-19" }, { "identity": "rim", "map": ".id" } ], "max": "1", "min": 1, "path": "Encounter.identifier", "short": "Identifier(s) by which this encounter is known", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "Encounter.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "Encounter.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "Encounter.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "Encounter.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "Encounter.identifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 1, "path": "Encounter.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "example": [ { "label": "General", "valueString": "123456" } ], "id": "Encounter.identifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Encounter.identifier.value", "short": "The value that is unique", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "Encounter.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Encounter.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "Encounter.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 1, "path": "Encounter.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Encounter.status" }, "binding": { "description": "Current state of the encounter.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EncounterStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-status|4.0.1" }, "comment": "Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +.", "id": "Encounter.status", "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, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "v2", "map": "No clear equivalent in HL7 v2; active/finished could be inferred from PV1-44, PV1-45, PV2-24; inactive could be inferred from PV2-16" }, { "identity": "rim", "map": ".statusCode" } ], "max": "1", "min": 1, "path": "Encounter.status", "short": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Encounter.statusHistory" }, "comment": "The current status is always found in the current version of the resource, not the status history.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "StatusHistory" } ], "id": "Encounter.statusHistory", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Encounter.statusHistory", "short": "List of past encounter statuses", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.statusHistory.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.statusHistory.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.statusHistory.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.statusHistory.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Encounter.statusHistory.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Encounter.statusHistory.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Encounter.statusHistory.status" }, "binding": { "description": "Current state of the encounter.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EncounterStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-status|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +.", "id": "Encounter.statusHistory.status", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Encounter.statusHistory.status", "short": "planned | arrived | triaged | in-progress | onleave | finished | cancelled +", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Encounter.statusHistory.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The time that the episode was in the specified status.", "id": "Encounter.statusHistory.period", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Encounter.statusHistory.period", "short": "The time that the episode was in the specified status", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 1, "path": "Encounter.class" }, "binding": { "description": "Classification of the encounter.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EncounterClass" } ], "strength": "extensible", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.", "id": "Encounter.class", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "v2", "map": "PV1-2" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code" } ], "max": "1", "min": 1, "path": "Encounter.class", "short": "Classification of patient encounter", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.class.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.class.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.class.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.class.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Encounter.class.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Encounter.class.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Encounter.class.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Encounter.class.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Encounter.class.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Encounter.class.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Encounter.class.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Encounter.class.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Encounter.class.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Encounter.class.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "*", "min": 0, "path": "Encounter.classHistory" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "ClassHistory" } ], "id": "Encounter.classHistory", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Encounter.classHistory", "short": "List of past encounter classes", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.classHistory.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.classHistory.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.classHistory.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.classHistory.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Encounter.classHistory.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Encounter.classHistory.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Encounter.classHistory.class" }, "binding": { "description": "Classification of the encounter.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EncounterClass" } ], "strength": "extensible", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "inpatient | outpatient | ambulatory | emergency +.", "id": "Encounter.classHistory.class", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Encounter.classHistory.class", "short": "inpatient | outpatient | ambulatory | emergency +", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 1, "path": "Encounter.classHistory.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The time that the episode was in the specified class.", "id": "Encounter.classHistory.period", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Encounter.classHistory.period", "short": "The time that the episode was in the specified class", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "Encounter.type" }, "binding": { "description": "The type of encounter.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EncounterType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-type" }, "comment": "Since there are many ways to further classify encounters, this element is 0..*.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).", "id": "Encounter.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "v2", "map": "PV1-4 / PV1-18" }, { "identity": "rim", "map": ".code" } ], "max": "0", "min": 0, "path": "Encounter.type", "short": "Specific type of encounter", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.serviceType" }, "binding": { "description": "Broad categorization of the service that is to be provided.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EncounterServiceType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/service-type" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Broad categorization of the service that is to be provided (e.g. cardiology).", "id": "Encounter.serviceType", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "v2", "map": "PV1-10" }, { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Encounter.serviceType", "short": "Specific type of service", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.priority" }, "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/PrioritiesValueSetOH" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the urgency of the encounter.", "id": "Encounter.priority", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.grade" }, { "identity": "v2", "map": "PV2-25" }, { "identity": "rim", "map": ".priorityCode" } ], "max": "1", "min": 0, "path": "Encounter.priority", "short": "Indicates the urgency of the encounter", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.priority.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.priority.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.priority.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.priority.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Encounter.priority.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Encounter.priority.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.priority.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.priority.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.priority.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.priority.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Encounter.priority.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Encounter.priority.coding.system", "patternUri": "https://fhir.onehealth.com.pe/CodeSystem/PrioritiesCodeSystemOH", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Encounter.priority.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Encounter.priority.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Encounter.priority.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Encounter.priority.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Encounter.priority.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Encounter.priority.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Encounter.priority.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Encounter.priority.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Encounter.priority.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Encounter.priority.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "patient" ], "base": { "max": "1", "min": 0, "path": "Encounter.subject" }, "comment": "While the encounter is always about the patient, the patient might not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The patient or group present at the encounter.", "id": "Encounter.subject", "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[classCode=PAT]" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 1, "path": "Encounter.subject", "short": "The patient or group present at the encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Encounter.episodeOfCare" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).", "id": "Encounter.episodeOfCare", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.context" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "v2", "map": "PV1-54, PV1-53" }, { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "Encounter.episodeOfCare", "short": "Episode(s) of care that this encounter should be recorded against", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" ] } ] }, { "alias": [ "incomingReferral" ], "base": { "max": "*", "min": 0, "path": "Encounter.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The request this encounter satisfies (e.g. incoming referral or procedure request).", "id": "Encounter.basedOn", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "rim", "map": ".reason.ClinicalDocument" } ], "max": "*", "min": 0, "path": "Encounter.basedOn", "short": "The ServiceRequest that initiated this encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ServiceRequestOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Encounter.participant" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The list of people responsible for providing the service.", "id": "Encounter.participant", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer" }, { "identity": "v2", "map": "ROL" }, { "identity": "rim", "map": ".participation[typeCode=PFM]" } ], "max": "*", "min": 1, "path": "Encounter.participant", "short": "List of participants involved in the encounter", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.participant.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.participant.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.participant.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.participant.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Encounter.participant.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Encounter.participant.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Encounter.participant.type" }, "binding": { "description": "Role of participant in encounter.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ParticipantType" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-participant-type" }, "comment": "The participant type indicates how an individual participates in an encounter. It includes non-practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the practitioner roles which are functional roles, derived from terms of employment, education, licensing, etc.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Role of participant in encounter.", "id": "Encounter.participant.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer.function" }, { "identity": "v2", "map": "ROL-3 (or maybe PRT-4)" }, { "identity": "rim", "map": ".functionCode" } ], "max": "*", "min": 0, "path": "Encounter.participant.type", "short": "Role of participant in encounter", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.participant.type.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.participant.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.participant.type.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.participant.type.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Encounter.participant.type.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Encounter.participant.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.participant.type.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.participant.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.participant.type.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.participant.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-participant-type" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Encounter.participant.type.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 0, "path": "Encounter.participant.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Encounter.participant.type.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Encounter.participant.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Encounter.participant.type.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 0, "path": "Encounter.participant.type.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Encounter.participant.type.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 0, "path": "Encounter.participant.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Encounter.participant.type.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Encounter.participant.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Encounter.participant.type.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Encounter.participant.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.participant.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period.", "id": "Encounter.participant.period", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "ROL-5, ROL-6 (or maybe PRT-5)" }, { "identity": "rim", "map": ".time" } ], "max": "0", "min": 0, "path": "Encounter.participant.period", "short": "Period of time during the encounter that the participant participated", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.participant.individual" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Persons involved in the encounter other than the patient.", "id": "Encounter.participant.individual", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "w5", "map": "FiveWs.who" }, { "identity": "v2", "map": "ROL-4" }, { "identity": "rim", "map": ".role" } ], "max": "1", "min": 1, "path": "Encounter.participant.individual", "short": "Persons involved in the encounter other than the patient", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Encounter.appointment" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The appointment that scheduled this encounter.", "id": "Encounter.appointment", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "SCH-1 / SCH-2" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target[classCode=ENC, moodCode=APT]" } ], "max": "*", "min": 0, "path": "Encounter.appointment", "short": "The appointment that scheduled this encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/AppointmentOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.period" }, "comment": "If not (yet) known, the end of the Period may be omitted.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The start and end time of the encounter.", "id": "Encounter.period", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "v2", "map": "PV1-44, PV1-45" }, { "identity": "rim", "map": ".effectiveTime (low & high)" } ], "max": "1", "min": 1, "path": "Encounter.period", "short": "The start and end time of the encounter", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.length" }, "comment": "May differ from the time the Encounter.period lasted because of leave of absence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Quantity of time the encounter lasted. This excludes the time during leaves of absence.", "id": "Encounter.length", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "v2", "map": "(PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes" }, { "identity": "rim", "map": ".lengthOfStayQuantity" } ], "max": "1", "min": 0, "path": "Encounter.length", "short": "Quantity of time the encounter lasted (less time absent)", "type": [ { "code": "Duration" } ] }, { "alias": [ "Indication", "Admission diagnosis" ], "base": { "max": "*", "min": 0, "path": "Encounter.reasonCode" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-reason" }, "comment": "For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.", "id": "Encounter.reasonCode", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.reasonCode" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "v2", "map": "EVN-4 / PV2-3 (note: PV2-3 is nominally constrained to inpatient admissions; HL7 v2 makes no vocabulary suggestions for PV2-3; would not expect PV2 segment or PV2-3 to be in use in all implementations )" }, { "identity": "rim", "map": ".reasonCode" } ], "max": "*", "min": 0, "path": "Encounter.reasonCode", "short": "Coded reason the encounter takes place", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.reasonCode.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.reasonCode.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.reasonCode.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.reasonCode.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Encounter.reasonCode.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Encounter.reasonCode.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.reasonCode.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.reasonCode.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.reasonCode.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.reasonCode.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Encounter.reasonCode.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 0, "path": "Encounter.reasonCode.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Encounter.reasonCode.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Encounter.reasonCode.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Encounter.reasonCode.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 0, "path": "Encounter.reasonCode.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Encounter.reasonCode.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 0, "path": "Encounter.reasonCode.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Encounter.reasonCode.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Encounter.reasonCode.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Encounter.reasonCode.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Encounter.reasonCode.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "Indication", "Admission diagnosis" ], "base": { "max": "*", "min": 0, "path": "Encounter.reasonReference" }, "comment": "For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.", "id": "Encounter.reasonReference", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.reasonCode" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "v2", "map": "EVN-4 / PV2-3 (note: PV2-3 is nominally constrained to inpatient admissions; HL7 v2 makes no vocabulary suggestions for PV2-3; would not expect PV2 segment or PV2-3 to be in use in all implementations )" }, { "identity": "rim", "map": ".reasonCode" } ], "max": "0", "min": 0, "path": "Encounter.reasonReference", "short": "Reason the encounter takes place (reference)", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Procedure", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Encounter.diagnosis" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The list of diagnosis relevant to this encounter.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Diagnosis" } ], "id": "Encounter.diagnosis", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON]" } ], "max": "*", "min": 0, "path": "Encounter.diagnosis", "short": "The list of diagnosis relevant to this encounter", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.diagnosis.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.diagnosis.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.diagnosis.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.diagnosis.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Encounter.diagnosis.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Encounter.diagnosis.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "alias": [ "Admission diagnosis", "discharge diagnosis", "indication" ], "base": { "max": "1", "min": 1, "path": "Encounter.diagnosis.condition" }, "comment": "For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.", "id": "Encounter.diagnosis.condition", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.reasonReference" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "v2", "map": "Resources that would commonly referenced at Encounter.indication would be Condition and/or Procedure. These most closely align with DG1/PRB and PR1 respectively." }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target" } ], "max": "1", "min": 1, "path": "Encounter.diagnosis.condition", "short": "The diagnosis or procedure relevant to the encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.diagnosis.use" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/diagnosis-role" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).", "id": "Encounter.diagnosis.use", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.diagnosis.use", "short": "Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.diagnosis.use.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.diagnosis.use.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.diagnosis.use.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.diagnosis.use.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Encounter.diagnosis.use.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Encounter.diagnosis.use.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.diagnosis.use.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.diagnosis.use.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.diagnosis.use.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.diagnosis.use.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Encounter.diagnosis.use.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Encounter.diagnosis.use.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Encounter.diagnosis.use.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Encounter.diagnosis.use.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Encounter.diagnosis.use.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Encounter.diagnosis.use.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Encounter.diagnosis.use.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 0, "path": "Encounter.diagnosis.use.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Encounter.diagnosis.use.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Encounter.diagnosis.use.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Encounter.diagnosis.use.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Encounter.diagnosis.use.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.diagnosis.rank" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Ranking of the diagnosis (for each role type).", "id": "Encounter.diagnosis.rank", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].priority" } ], "max": "1", "min": 0, "path": "Encounter.diagnosis.rank", "short": "Ranking of the diagnosis (for each role type)", "type": [ { "code": "positiveInt" } ] }, { "base": { "max": "*", "min": 0, "path": "Encounter.account" }, "comment": "The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The set of accounts that may be used for billing for this Encounter.", "id": "Encounter.account", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".pertains.A_Account" } ], "max": "1", "min": 0, "path": "Encounter.account", "short": "The set of accounts that may be used for billing for this Encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/AccountOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.hospitalization" }, "comment": "An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included.\r\rThe duration recorded in the period of this encounter covers the entire scope of this hospitalization record.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Details about the admission to a healthcare service.", "id": "Encounter.hospitalization", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=ENC, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Encounter.hospitalization", "short": "Details about the admission to a healthcare service", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.hospitalization.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.hospitalization.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.hospitalization.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.hospitalization.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Encounter.hospitalization.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Encounter.hospitalization.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.hospitalization.preAdmissionIdentifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Pre-admission identifier.", "id": "Encounter.hospitalization.preAdmissionIdentifier", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PV1-5" }, { "identity": "rim", "map": ".id" } ], "max": "1", "min": 0, "path": "Encounter.hospitalization.preAdmissionIdentifier", "short": "Pre-admission identifier", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.hospitalization.origin" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location/organization from which the patient came before admission.", "id": "Encounter.hospitalization.origin", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=ORG].role" } ], "max": "1", "min": 0, "path": "Encounter.hospitalization.origin", "short": "The location/organization from which the patient came before admission", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.hospitalization.admitSource" }, "binding": { "description": "From where the patient was admitted.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdmitSource" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-admit-source" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "From where patient was admitted (physician referral, transfer).", "id": "Encounter.hospitalization.admitSource", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PV1-14" }, { "identity": "rim", "map": ".admissionReferralSourceCode" } ], "max": "1", "min": 0, "path": "Encounter.hospitalization.admitSource", "short": "From where patient was admitted (physician referral, transfer)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.hospitalization.reAdmission" }, "binding": { "description": "The reason for re-admission of this hospitalization encounter.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ReAdmissionType" } ], "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v2-0092" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Whether this hospitalization is a readmission and why if known.", "id": "Encounter.hospitalization.reAdmission", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PV1-13" }, { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.hospitalization.reAdmission", "short": "The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Encounter.hospitalization.dietPreference" }, "binding": { "description": "Medical, cultural or ethical food preferences to help with catering requirements.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PatientDiet" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-diet" }, "comment": "For example, a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Diet preferences reported by the patient.", "id": "Encounter.hospitalization.dietPreference", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PV1-38" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=EVN, code=\"diet\"]" } ], "max": "*", "min": 0, "path": "Encounter.hospitalization.dietPreference", "requirements": "Used to track patient's diet restrictions and/or preference. For a complete description of the nutrition needs of a patient during their stay, one should use the nutritionOrder resource which links to Encounter.", "short": "Diet preferences reported by the patient", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Encounter.hospitalization.specialCourtesy" }, "binding": { "description": "Special courtesies.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Courtesies" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-special-courtesy" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Special courtesies (VIP, board member).", "id": "Encounter.hospitalization.specialCourtesy", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PV1-16" }, { "identity": "rim", "map": ".specialCourtesiesCode" } ], "max": "*", "min": 0, "path": "Encounter.hospitalization.specialCourtesy", "short": "Special courtesies (VIP, board member)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Encounter.hospitalization.specialArrangement" }, "binding": { "description": "Special arrangements.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Arrangements" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-special-arrangements" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.", "id": "Encounter.hospitalization.specialArrangement", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PV1-15 / OBR-30 / OBR-43" }, { "identity": "rim", "map": ".specialArrangementCode" } ], "max": "*", "min": 0, "path": "Encounter.hospitalization.specialArrangement", "short": "Wheelchair, translator, stretcher, etc.", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.hospitalization.destination" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Location/organization to which the patient is discharged.", "id": "Encounter.hospitalization.destination", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PV1-37" }, { "identity": "rim", "map": ".participation[typeCode=DST]" } ], "max": "1", "min": 0, "path": "Encounter.hospitalization.destination", "short": "Location/organization to which the patient is discharged", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.hospitalization.dischargeDisposition" }, "binding": { "description": "Discharge Disposition.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DischargeDisp" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-discharge-disposition" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Category or kind of location after discharge.", "id": "Encounter.hospitalization.dischargeDisposition", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "PV1-36" }, { "identity": "rim", "map": ".dischargeDispositionCode" } ], "max": "1", "min": 0, "path": "Encounter.hospitalization.dischargeDisposition", "short": "Category or kind of location after discharge", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Encounter.location" }, "comment": "Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type \"kind\" such as \"client's home\" and an encounter.class = \"virtual\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "List of locations where the patient has been during this encounter.", "id": "Encounter.location", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=LOC]" } ], "max": "1", "min": 1, "path": "Encounter.location", "short": "List of locations where the patient has been", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Encounter.location.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Encounter.location.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Encounter.location.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Encounter.location.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Encounter.location.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Encounter.location.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Encounter.location.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location where the encounter takes place.", "id": "Encounter.location.location", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.location" }, { "identity": "w5", "map": "FiveWs.where[x]" }, { "identity": "v2", "map": "PV1-3 / PV1-6 / PV1-11 / PV1-42 / PV1-43" }, { "identity": "rim", "map": ".role" } ], "max": "1", "min": 1, "path": "Encounter.location.location", "short": "Location the encounter takes place", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/LocationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.location.status" }, "binding": { "description": "The status of the location.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EncounterLocationStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1" }, "comment": "When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.", "id": "Encounter.location.status", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".role.statusCode" } ], "max": "0", "min": 0, "path": "Encounter.location.status", "short": "planned | active | reserved | completed", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.location.physicalType" }, "binding": { "description": "Physical form of the location.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PhysicalType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/location-physical-type" }, "comment": "This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query.\n\nThere may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query.", "id": "Encounter.location.physicalType", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "Encounter.location.physicalType", "short": "The physical type of the location (usually the level in the location hierachy - bed room ward etc.)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.location.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which the patient was present at the location.", "id": "Encounter.location.period", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".time" } ], "max": "0", "min": 0, "path": "Encounter.location.period", "short": "Time period during which the patient was present at the location", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.serviceProvider" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.", "id": "Encounter.serviceProvider", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "v2", "map": "PL.6 & PL.1" }, { "identity": "rim", "map": ".particiaption[typeCode=PFM].role" } ], "max": "1", "min": 1, "path": "Encounter.serviceProvider", "short": "The organization (facility) responsible for this encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Encounter.partOf" }, "comment": "This is also used for associating a child's encounter back to the mother's encounter.\r\rRefer to the Notes section in the Patient resource for further details.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Another Encounter of which this encounter is a part of (administratively or in time).", "id": "Encounter.partOf", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=COMP, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Encounter.partOf", "short": "Another Encounter this encounter is part of", "type": [ { "code": "Reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", "valueBoolean": true } ], "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ] } ] }, "status": "draft", "title": "OneHealth Encounter", "type": "Encounter", "url": "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH", "version": "2.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/DocumentReferenceOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DocumentReference", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR DocumentReferenceOH Profile, for OH interoperability scenarios, based on the national CORE DocumentReference Profile defined by HL7 OH.", "differential": { "element": [ { "id": "DocumentReference.masterIdentifier", "max": "0", "path": "DocumentReference.masterIdentifier" }, { "id": "DocumentReference.identifier", "min": 1, "path": "DocumentReference.identifier" }, { "id": "DocumentReference.identifier.use", "max": "0", "path": "DocumentReference.identifier.use" }, { "id": "DocumentReference.identifier.type", "max": "0", "path": "DocumentReference.identifier.type" }, { "id": "DocumentReference.identifier.system", "min": 1, "path": "DocumentReference.identifier.system" }, { "id": "DocumentReference.identifier.value", "min": 1, "path": "DocumentReference.identifier.value" }, { "id": "DocumentReference.identifier.period", "max": "0", "path": "DocumentReference.identifier.period" }, { "id": "DocumentReference.identifier.assigner", "path": "DocumentReference.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/c80-doc-typecodes" }, "id": "DocumentReference.type.coding.system", "min": 1, "path": "DocumentReference.type.coding.system" }, { "id": "DocumentReference.type.coding.version", "max": "0", "path": "DocumentReference.type.coding.version" }, { "id": "DocumentReference.type.coding.code", "min": 1, "path": "DocumentReference.type.coding.code" }, { "id": "DocumentReference.type.coding.display", "min": 1, "path": "DocumentReference.type.coding.display" }, { "id": "DocumentReference.type.coding.userSelected", "max": "0", "path": "DocumentReference.type.coding.userSelected" }, { "id": "DocumentReference.type.text", "max": "0", "path": "DocumentReference.type.text" }, { "id": "DocumentReference.category", "max": "1", "min": 1, "path": "DocumentReference.category" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/document-classcodes" }, "id": "DocumentReference.category.coding.system", "min": 1, "path": "DocumentReference.category.coding.system" }, { "id": "DocumentReference.category.coding.version", "max": "0", "path": "DocumentReference.category.coding.version" }, { "id": "DocumentReference.category.coding.code", "min": 1, "path": "DocumentReference.category.coding.code" }, { "id": "DocumentReference.category.coding.display", "min": 1, "path": "DocumentReference.category.coding.display" }, { "id": "DocumentReference.category.coding.userSelected", "max": "0", "path": "DocumentReference.category.coding.userSelected" }, { "id": "DocumentReference.category.text", "max": "0", "path": "DocumentReference.category.text" }, { "id": "DocumentReference.subject", "min": 1, "path": "DocumentReference.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "DocumentReference.date", "min": 1, "path": "DocumentReference.date" }, { "id": "DocumentReference.author", "max": "1", "min": 1, "path": "DocumentReference.author", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "DocumentReference.authenticator", "max": "0", "path": "DocumentReference.authenticator" }, { "id": "DocumentReference.custodian", "min": 1, "path": "DocumentReference.custodian", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "DocumentReference.relatesTo", "max": "0", "path": "DocumentReference.relatesTo" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/security-labels" }, "id": "DocumentReference.securityLabel.coding.system", "min": 1, "path": "DocumentReference.securityLabel.coding.system" }, { "id": "DocumentReference.securityLabel.coding.version", "max": "0", "path": "DocumentReference.securityLabel.coding.version" }, { "id": "DocumentReference.securityLabel.coding.code", "min": 1, "path": "DocumentReference.securityLabel.coding.code" }, { "id": "DocumentReference.securityLabel.coding.display", "min": 1, "path": "DocumentReference.securityLabel.coding.display" }, { "id": "DocumentReference.securityLabel.coding.userSelected", "max": "0", "path": "DocumentReference.securityLabel.coding.userSelected" }, { "id": "DocumentReference.securityLabel.text", "max": "0", "path": "DocumentReference.securityLabel.text" }, { "id": "DocumentReference.content.format", "min": 1, "path": "DocumentReference.content.format" }, { "id": "DocumentReference.content.format.system", "max": "0", "path": "DocumentReference.content.format.system" }, { "id": "DocumentReference.content.format.code", "min": 1, "path": "DocumentReference.content.format.code", "patternCode": "PDF" }, { "id": "DocumentReference.content.format.display", "min": 1, "path": "DocumentReference.content.format.display" }, { "id": "DocumentReference.content.format.userSelected", "max": "0", "path": "DocumentReference.content.format.userSelected" }, { "id": "DocumentReference.context.encounter", "max": "0", "path": "DocumentReference.context.encounter" }, { "id": "DocumentReference.context.event", "max": "0", "path": "DocumentReference.context.event" }, { "id": "DocumentReference.context.period", "max": "0", "path": "DocumentReference.context.period" }, { "id": "DocumentReference.context.facilityType", "max": "0", "path": "DocumentReference.context.facilityType" }, { "id": "DocumentReference.context.practiceSetting", "max": "0", "path": "DocumentReference.context.practiceSetting" }, { "id": "DocumentReference.context.sourcePatientInfo", "max": "0", "path": "DocumentReference.context.sourcePatientInfo" }, { "id": "DocumentReference.context.related", "path": "DocumentReference.context.related", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/AppointmentOH", "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH", "https://fhir.onehealth.com.pe/StructureDefinition/ServiceRequestOH" ] } ] } ] }, "fhirVersion": "4.0.1", "id": "DocumentReferenceOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "fhircomposition", "name": "FHIR Composition", "uri": "http://hl7.org/fhir/composition" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "cda", "name": "CDA (R2)", "uri": "http://hl7.org/v3/cda" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "xds", "name": "XDS metadata equivalent", "uri": "http://ihe.net/xds" } ], "meta": { "lastUpdated": "2024-04-12T17:46:19.718916+00:00", "versionId": "MTcxMjk0Mzk3OTcxODkxNjAwMA" }, "name": "DocumentReferenceOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "DocumentReference" }, "comment": "Usually, this is used for documents other than those defined by FHIR.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.", "id": "DocumentReference", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "fhircomposition", "map": "when describing a Composition" }, { "identity": "rim", "map": "Document[classCode=\"DOC\" and moodCode=\"EVN\"]" }, { "identity": "cda", "map": "when describing a CDA" } ], "max": "*", "min": 0, "path": "DocumentReference", "short": "A reference to a document" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "DocumentReference.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "DocumentReference.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "DocumentReference.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "DocumentReference.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "DocumentReference.implicitRules", "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, "max": "1", "min": 0, "path": "DocumentReference.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "DocumentReference.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "DocumentReference.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "DocumentReference.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "DocumentReference.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "DocumentReference.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "DocumentReference.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DocumentReference.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "DocumentReference.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "DocumentReference.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "DocumentReference.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "DocumentReference.masterIdentifier" }, "comment": "CDA Document Id extension and root.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.", "id": "DocumentReference.masterIdentifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "fhircomposition", "map": "Composition.identifier" }, { "identity": "v2", "map": "TXA-12" }, { "identity": "rim", "map": ".id" }, { "identity": "xds", "map": "DocumentEntry.uniqueId" }, { "identity": "cda", "map": "ClinicalDocument/id" } ], "max": "0", "min": 0, "path": "DocumentReference.masterIdentifier", "requirements": "The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form \"oid^extension\", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.).", "short": "Master Version Specific Identifier", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "*", "min": 0, "path": "DocumentReference.identifier" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Other identifiers associated with the document, including version independent identifiers.", "id": "DocumentReference.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "TXA-16?" }, { "identity": "rim", "map": ".id / .setId" }, { "identity": "xds", "map": "DocumentEntry.entryUUID" } ], "max": "*", "min": 1, "path": "DocumentReference.identifier", "short": "Other identifiers for the document", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DocumentReference.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DocumentReference.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DocumentReference.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DocumentReference.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "DocumentReference.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "DocumentReference.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "DocumentReference.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "DocumentReference.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "DocumentReference.identifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 1, "path": "DocumentReference.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "example": [ { "label": "General", "valueString": "123456" } ], "id": "DocumentReference.identifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "DocumentReference.identifier.value", "short": "The value that is unique", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "DocumentReference.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "DocumentReference.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "DocumentReference.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 0, "path": "DocumentReference.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 1, "path": "DocumentReference.status" }, "binding": { "description": "The status of the document reference.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentReferenceStatus" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1" }, "comment": "This is the status of the DocumentReference object, which might be independent from the docStatus element.\n\nThis element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status of this document reference.", "id": "DocumentReference.status", "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, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "v2", "map": "TXA-19" }, { "identity": "rim", "map": "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\"; final: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct()]); amended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct() and statusCode=\"completed\"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\"" }, { "identity": "xds", "map": "DocumentEntry.availabilityStatus" } ], "max": "1", "min": 1, "path": "DocumentReference.status", "short": "current | superseded | entered-in-error", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "DocumentReference.docStatus" }, "binding": { "description": "Status of the underlying document.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ReferredDocumentStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/composition-status|4.0.1" }, "comment": "The document that is pointed to might be in various lifecycle states.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status of the underlying document.", "id": "DocumentReference.docStatus", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.status" }, { "identity": "fhircomposition", "map": "Composition.status" }, { "identity": "v2", "map": "TXA-17" }, { "identity": "rim", "map": ".statusCode" } ], "max": "1", "min": 0, "path": "DocumentReference.docStatus", "short": "preliminary | final | amended | entered-in-error", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "DocumentReference.type" }, "binding": { "description": "Precise type of clinical document.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentC80Type" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/c80-doc-typecodes" }, "comment": "Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.", "id": "DocumentReference.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "fhircomposition", "map": "Composition.type" }, { "identity": "v2", "map": "TXA-2" }, { "identity": "rim", "map": "./code" }, { "identity": "xds", "map": "DocumentEntry.type" }, { "identity": "cda", "map": "ClinicalDocument/code/@code \n\nThe typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted." } ], "max": "1", "min": 0, "path": "DocumentReference.type", "short": "Kind of document (LOINC if possible)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DocumentReference.type.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DocumentReference.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DocumentReference.type.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DocumentReference.type.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "DocumentReference.type.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "DocumentReference.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DocumentReference.type.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DocumentReference.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DocumentReference.type.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DocumentReference.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/c80-doc-typecodes" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "DocumentReference.type.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "DocumentReference.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "DocumentReference.type.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "DocumentReference.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "DocumentReference.type.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "DocumentReference.type.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DocumentReference.type.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "DocumentReference.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "DocumentReference.type.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "DocumentReference.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DocumentReference.type.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "DocumentReference.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "claxs" ], "base": { "max": "*", "min": 0, "path": "DocumentReference.category" }, "binding": { "description": "High-level kind of a clinical document at a macro level.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentC80Class" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/document-classcodes" }, "comment": "Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.", "id": "DocumentReference.category", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "fhircomposition", "map": "Composition.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" }, { "identity": "xds", "map": "DocumentEntry.class" }, { "identity": "cda", "map": "Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service, based on the LOINC Type of Service (see Page 53 of the LOINC User's Manual). Must be consistent with /ClinicalDocument/code/@code" } ], "max": "1", "min": 1, "path": "DocumentReference.category", "short": "Categorization of document", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DocumentReference.category.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DocumentReference.category.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DocumentReference.category.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DocumentReference.category.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "DocumentReference.category.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "DocumentReference.category.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DocumentReference.category.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DocumentReference.category.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DocumentReference.category.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DocumentReference.category.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/document-classcodes" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "DocumentReference.category.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "DocumentReference.category.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "DocumentReference.category.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "DocumentReference.category.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "DocumentReference.category.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "DocumentReference.category.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DocumentReference.category.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "DocumentReference.category.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "DocumentReference.category.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "DocumentReference.category.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DocumentReference.category.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "DocumentReference.category.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "DocumentReference.subject" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).", "id": "DocumentReference.subject", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "fhircomposition", "map": "Composition.subject" }, { "identity": "v2", "map": "PID-3 (No standard way to define a Practitioner or Group subject in HL7 v2 MDM message)" }, { "identity": "rim", "map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]" }, { "identity": "xds", "map": "DocumentEntry.patientId" }, { "identity": "cda", "map": "ClinicalDocument/recordTarget/" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 1, "path": "DocumentReference.subject", "short": "Who/what is the subject of the document", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "alias": [ "indexed" ], "base": { "max": "1", "min": 0, "path": "DocumentReference.date" }, "comment": "Referencing/indexing time is used for tracking, organizing versions and searching.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When the document reference was created.", "id": "DocumentReference.date", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.recorded" }, { "identity": "fhircomposition", "map": "Composition.date" }, { "identity": "rim", "map": ".availabilityTime[type=\"TS\"]" } ], "max": "1", "min": 1, "path": "DocumentReference.date", "short": "When this document reference was created", "type": [ { "code": "instant" } ] }, { "base": { "max": "*", "min": 0, "path": "DocumentReference.author" }, "comment": "Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies who is responsible for adding the information to the document.", "id": "DocumentReference.author", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "fhircomposition", "map": "Composition.author" }, { "identity": "v2", "map": "TXA-9 (No standard way to indicate a Device in HL7 v2 MDM message)" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "xds", "map": "DocumentEntry.author" }, { "identity": "cda", "map": "ClinicalDocument/author" } ], "max": "1", "min": 1, "path": "DocumentReference.author", "short": "Who and/or what authored the document", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "DocumentReference.authenticator" }, "comment": "Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Which person or organization authenticates that this document is valid.", "id": "DocumentReference.authenticator", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "w5", "map": "FiveWs.witness" }, { "identity": "fhircomposition", "map": "Composition.attester" }, { "identity": "v2", "map": "TXA-10" }, { "identity": "rim", "map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "xds", "map": "DocumentEntry.legalAuthenticator" }, { "identity": "cda", "map": "ClinicalDocument/legalAuthenticator" } ], "max": "0", "min": 0, "path": "DocumentReference.authenticator", "short": "Who/what authenticated the document", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "DocumentReference.custodian" }, "comment": "Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.", "id": "DocumentReference.custodian", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "fhircomposition", "map": "Composition.custodian" }, { "identity": "rim", "map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]" } ], "max": "1", "min": 1, "path": "DocumentReference.custodian", "short": "Organization which maintains the document", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "DocumentReference.relatesTo" }, "comment": "This element is labeled as a modifier because documents that append to other documents are incomplete on their own.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Relationships that this document has with other document references that already exist.", "id": "DocumentReference.relatesTo", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "fhircomposition", "map": "Composition.relatesTo" }, { "identity": "rim", "map": ".outboundRelationship" }, { "identity": "xds", "map": "DocumentEntry Associations" } ], "max": "0", "min": 0, "path": "DocumentReference.relatesTo", "short": "Relationships to other documents", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DocumentReference.relatesTo.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DocumentReference.relatesTo.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DocumentReference.relatesTo.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DocumentReference.relatesTo.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "DocumentReference.relatesTo.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "DocumentReference.relatesTo.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "DocumentReference.relatesTo.code" }, "binding": { "description": "The type of relationship between documents.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentRelationshipType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1" }, "comment": "If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The type of relationship that this document has with anther document.", "id": "DocumentReference.relatesTo.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "fhircomposition", "map": "Composition.relatesTo.code" }, { "identity": "rim", "map": ".outboundRelationship.typeCode" }, { "identity": "xds", "map": "DocumentEntry Associations type" } ], "max": "1", "min": 1, "path": "DocumentReference.relatesTo.code", "short": "replaces | transforms | signs | appends", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "DocumentReference.relatesTo.target" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The target document of this relationship.", "id": "DocumentReference.relatesTo.target", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "fhircomposition", "map": "Composition.relatesTo.target" }, { "identity": "rim", "map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id" }, { "identity": "xds", "map": "DocumentEntry Associations reference" } ], "max": "1", "min": 1, "path": "DocumentReference.relatesTo.target", "short": "Target of the relationship", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DocumentReference" ] } ] }, { "base": { "max": "1", "min": 0, "path": "DocumentReference.description" }, "comment": "What the document is about, a terse summary of the document.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Human-readable description of the source document.", "id": "DocumentReference.description", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "TXA-25" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"SUBJ\"].target.text" }, { "identity": "xds", "map": "DocumentEntry.comments" } ], "max": "1", "min": 0, "path": "DocumentReference.description", "requirements": "Helps humans to assess whether the document is of interest.", "short": "Human-readable description", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "DocumentReference.securityLabel" }, "binding": { "description": "Security Labels from the Healthcare Privacy and Security Classification System.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SecurityLabels" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/security-labels" }, "comment": "The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. \n\nIn the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the \"reference\" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.", "id": "DocumentReference.securityLabel", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "fhircomposition", "map": "Composition.confidentiality, Composition.meta.security" }, { "identity": "v2", "map": "TXA-18" }, { "identity": "rim", "map": ".confidentialityCode" }, { "identity": "xds", "map": "DocumentEntry.confidentialityCode" }, { "identity": "cda", "map": "ClinicalDocument/confidentialityCode/@code" } ], "max": "*", "min": 0, "path": "DocumentReference.securityLabel", "requirements": "Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.", "short": "Document security-tags", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DocumentReference.securityLabel.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DocumentReference.securityLabel.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DocumentReference.securityLabel.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DocumentReference.securityLabel.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "DocumentReference.securityLabel.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "DocumentReference.securityLabel.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DocumentReference.securityLabel.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DocumentReference.securityLabel.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DocumentReference.securityLabel.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DocumentReference.securityLabel.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/security-labels" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "DocumentReference.securityLabel.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "DocumentReference.securityLabel.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "DocumentReference.securityLabel.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "DocumentReference.securityLabel.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "DocumentReference.securityLabel.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "DocumentReference.securityLabel.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DocumentReference.securityLabel.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "DocumentReference.securityLabel.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "DocumentReference.securityLabel.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "DocumentReference.securityLabel.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DocumentReference.securityLabel.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "DocumentReference.securityLabel.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 1, "path": "DocumentReference.content" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The document and format referenced. There may be multiple content element repetitions, each with a different format.", "id": "DocumentReference.content", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "fhircomposition", "map": "Bundle(Composition+*)" }, { "identity": "rim", "map": "document.text" } ], "max": "*", "min": 1, "path": "DocumentReference.content", "short": "Document referenced", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DocumentReference.content.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DocumentReference.content.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DocumentReference.content.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DocumentReference.content.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "DocumentReference.content.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "DocumentReference.content.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "DocumentReference.content.attachment" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The document or URL of the document along with critical metadata to prove content has integrity.", "id": "DocumentReference.content.attachment", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "fhircomposition", "map": "Composition.language, \nComposition.title, \nComposition.date" }, { "identity": "v2", "map": "TXA-3 for mime type" }, { "identity": "rim", "map": "document.text" }, { "identity": "xds", "map": "DocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime" }, { "identity": "cda", "map": "ClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date" } ], "max": "1", "min": 1, "path": "DocumentReference.content.attachment", "short": "Where to access the document", "type": [ { "code": "Attachment" } ] }, { "base": { "max": "1", "min": 0, "path": "DocumentReference.content.format" }, "binding": { "description": "Document Format Codes.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentFormat" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/formatcodes" }, "comment": "Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.", "id": "DocumentReference.content.format", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "fhircomposition", "map": "Composition.meta.profile" }, { "identity": "rim", "map": "document.text" }, { "identity": "xds", "map": "DocumentEntry.formatCode" }, { "identity": "cda", "map": "derived from the IHE Profile or Implementation Guide templateID" } ], "max": "1", "min": 1, "path": "DocumentReference.content.format", "short": "Format/content rules for the document", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DocumentReference.content.format.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DocumentReference.content.format.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DocumentReference.content.format.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DocumentReference.content.format.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "DocumentReference.content.format.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "0", "min": 0, "path": "DocumentReference.content.format.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "DocumentReference.content.format.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "1", "min": 0, "path": "DocumentReference.content.format.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "DocumentReference.content.format.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "DocumentReference.content.format.code", "patternCode": "PDF", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DocumentReference.content.format.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "DocumentReference.content.format.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "DocumentReference.content.format.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "DocumentReference.content.format.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "DocumentReference.context" }, "comment": "These values are primarily added to help with searching for interesting/relevant documents.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The clinical context in which the document was prepared.", "id": "DocumentReference.context", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']" } ], "max": "1", "min": 0, "path": "DocumentReference.context", "short": "Clinical context of document", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DocumentReference.context.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DocumentReference.context.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DocumentReference.context.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DocumentReference.context.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "DocumentReference.context.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "DocumentReference.context.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "DocumentReference.context.encounter" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes the clinical encounter or type of care that the document content is associated with.", "id": "DocumentReference.context.encounter", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.context" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "fhircomposition", "map": "Composition.encounter" }, { "identity": "rim", "map": "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])" } ], "max": "0", "min": 0, "path": "DocumentReference.context.encounter", "short": "Context of the document content", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter", "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" ] } ] }, { "base": { "max": "*", "min": 0, "path": "DocumentReference.context.event" }, "binding": { "description": "This list of codes represents the main clinical acts being documented.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentEventType" } ], "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActCode" }, "comment": "An event can further specialize the act inherent in the type, such as where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.", "id": "DocumentReference.context.event", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "fhircomposition", "map": "Composition.event.code" }, { "identity": "rim", "map": ".code" }, { "identity": "xds", "map": "DocumentEntry.eventCodeList" } ], "max": "0", "min": 0, "path": "DocumentReference.context.event", "short": "Main clinical acts documented", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "DocumentReference.context.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The time period over which the service that is described by the document was provided.", "id": "DocumentReference.context.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "fhircomposition", "map": "Composition.event.period" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "xds", "map": "DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime" }, { "identity": "cda", "map": "ClinicalDocument/documentationOf/\nserviceEvent/effectiveTime/low/\n@value --> ClinicalDocument/documentationOf/\nserviceEvent/effectiveTime/high/\n@value" } ], "max": "0", "min": 0, "path": "DocumentReference.context.period", "short": "Time of service that is being documented", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "DocumentReference.context.facilityType" }, "binding": { "description": "XDS Facility Type.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentC80FacilityType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/c80-facilitycodes" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The kind of facility where the patient was seen.", "id": "DocumentReference.context.facilityType", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "fhircomposition", "map": "usually from a mapping to a local ValueSet" }, { "identity": "rim", "map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code" }, { "identity": "xds", "map": "DocumentEntry.healthcareFacilityTypeCode" }, { "identity": "cda", "map": "usually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code" } ], "max": "0", "min": 0, "path": "DocumentReference.context.facilityType", "short": "Kind of facility where patient was seen", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "DocumentReference.context.practiceSetting" }, "binding": { "description": "Additional details about where the content was created (e.g. clinical specialty).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentC80PracticeSetting" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/c80-practice-codes" }, "comment": "This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.", "id": "DocumentReference.context.practiceSetting", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "fhircomposition", "map": "usually from a mapping to a local ValueSet" }, { "identity": "rim", "map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code" }, { "identity": "xds", "map": "DocumentEntry.practiceSettingCode" }, { "identity": "cda", "map": "usually from a mapping to a local ValueSet" } ], "max": "0", "min": 0, "path": "DocumentReference.context.practiceSetting", "requirements": "This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.", "short": "Additional details about where the content was created (e.g. clinical specialty)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "DocumentReference.context.sourcePatientInfo" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Patient Information as known when the document was published. May be a reference to a version specific, or contained.", "id": "DocumentReference.context.sourcePatientInfo", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "fhircomposition", "map": "Composition.subject" }, { "identity": "rim", "map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]" }, { "identity": "xds", "map": "DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId" }, { "identity": "cda", "map": "ClinicalDocument/recordTarget/" } ], "max": "0", "min": 0, "path": "DocumentReference.context.sourcePatientInfo", "short": "Patient demographics from source", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] } ] }, { "base": { "max": "*", "min": 0, "path": "DocumentReference.context.related" }, "comment": "May be identifiers or resources that caused the DocumentReference or referenced Document to be created.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Related identifiers or resources associated with the DocumentReference.", "id": "DocumentReference.context.related", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "fhircomposition", "map": "Composition.event.detail" }, { "identity": "rim", "map": "./outboundRelationship[typeCode=\"PERT\" and isNormalActRelationship()] / target[isNormalAct]" }, { "identity": "xds", "map": "DocumentEntry.referenceIdList" }, { "identity": "cda", "map": "ClinicalDocument/relatedDocument" } ], "max": "*", "min": 0, "path": "DocumentReference.context.related", "short": "Related identifiers or resources", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/AppointmentOH", "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH", "https://fhir.onehealth.com.pe/StructureDefinition/ServiceRequestOH" ] } ] } ] }, "status": "draft", "title": "OneHealth DocumentReference", "type": "DocumentReference", "url": "https://fhir.onehealth.com.pe/StructureDefinition/DocumentReferenceOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/DiagnosticReportNoteExchangeOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR DiagnosticReportNoteExchangeOH Profile, for OH interoperability scenarios, based on the national CORE DiagnosticReport Profile defined by HL7 OH.", "differential": { "element": [ { "id": "DiagnosticReport.basedOn", "max": "1", "path": "DiagnosticReport.basedOn", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ServiceRequestOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections" }, "id": "DiagnosticReport.category", "max": "1", "min": 1, "path": "DiagnosticReport.category" }, { "id": "DiagnosticReport.category.coding.system", "min": 1, "path": "DiagnosticReport.category.coding.system" }, { "id": "DiagnosticReport.category.coding.version", "max": "0", "path": "DiagnosticReport.category.coding.version" }, { "id": "DiagnosticReport.category.coding.code", "min": 1, "path": "DiagnosticReport.category.coding.code" }, { "id": "DiagnosticReport.category.coding.display", "min": 1, "path": "DiagnosticReport.category.coding.display" }, { "id": "DiagnosticReport.category.coding.userSelected", "max": "0", "path": "DiagnosticReport.category.coding.userSelected" }, { "id": "DiagnosticReport.category.text", "max": "0", "path": "DiagnosticReport.category.text" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/report-codes" }, "id": "DiagnosticReport.code", "path": "DiagnosticReport.code" }, { "id": "DiagnosticReport.code.coding.system", "min": 1, "path": "DiagnosticReport.code.coding.system" }, { "id": "DiagnosticReport.code.coding.version", "max": "0", "path": "DiagnosticReport.code.coding.version" }, { "id": "DiagnosticReport.code.coding.code", "min": 1, "path": "DiagnosticReport.code.coding.code" }, { "id": "DiagnosticReport.code.coding.display", "min": 1, "path": "DiagnosticReport.code.coding.display" }, { "id": "DiagnosticReport.code.coding.userSelected", "max": "0", "path": "DiagnosticReport.code.coding.userSelected" }, { "id": "DiagnosticReport.code.text", "max": "0", "path": "DiagnosticReport.code.text" }, { "id": "DiagnosticReport.subject", "min": 1, "path": "DiagnosticReport.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "DiagnosticReport.encounter", "path": "DiagnosticReport.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "id": "DiagnosticReport.effective[x]", "min": 1, "path": "DiagnosticReport.effective[x]", "short": "Diagnostically relevant time (typically the time of specimen collection)", "type": [ { "code": "dateTime" } ] }, { "id": "DiagnosticReport.issued", "min": 1, "path": "DiagnosticReport.issued", "short": "When the report was released" }, { "id": "DiagnosticReport.performer", "min": 1, "path": "DiagnosticReport.performer", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "DiagnosticReport.resultsInterpreter", "min": 1, "path": "DiagnosticReport.resultsInterpreter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "DiagnosticReport.result", "max": "0", "path": "DiagnosticReport.result" }, { "id": "DiagnosticReport.imagingStudy", "max": "0", "path": "DiagnosticReport.imagingStudy" }, { "id": "DiagnosticReport.media", "max": "0", "path": "DiagnosticReport.media" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings" }, "id": "DiagnosticReport.conclusionCode", "path": "DiagnosticReport.conclusionCode" }, { "id": "DiagnosticReport.conclusionCode.coding.system", "min": 1, "path": "DiagnosticReport.conclusionCode.coding.system" }, { "id": "DiagnosticReport.conclusionCode.coding.version", "max": "0", "path": "DiagnosticReport.conclusionCode.coding.version" }, { "id": "DiagnosticReport.conclusionCode.coding.code", "min": 1, "path": "DiagnosticReport.conclusionCode.coding.code" }, { "id": "DiagnosticReport.conclusionCode.coding.display", "min": 1, "path": "DiagnosticReport.conclusionCode.coding.display" }, { "id": "DiagnosticReport.conclusionCode.coding.userSelected", "max": "0", "path": "DiagnosticReport.conclusionCode.coding.userSelected" }, { "id": "DiagnosticReport.conclusionCode.text", "max": "0", "path": "DiagnosticReport.conclusionCode.text" } ] }, "fhirVersion": "4.0.1", "id": "DiagnosticReportNoteExchangeOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" } ], "meta": { "lastUpdated": "2024-04-12T17:46:17.444341+00:00", "versionId": "MTcxMjk0Mzk3NzQ0NDM0MTAwMA" }, "name": "DiagnosticReportNoteExchangeOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Report", "Test", "Result", "Results", "Labs", "Laboratory" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport" }, "comment": "This is intended to capture a single report and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.", "id": "DiagnosticReport", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "v2", "map": "ORU -> OBR" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=EVN]" } ], "max": "*", "min": 0, "path": "DiagnosticReport", "short": "A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "DiagnosticReport.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "DiagnosticReport.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "DiagnosticReport.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "DiagnosticReport.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "DiagnosticReport.implicitRules", "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, "max": "1", "min": 0, "path": "DiagnosticReport.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "DiagnosticReport.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "DiagnosticReport.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "DiagnosticReport.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "DiagnosticReport.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "DiagnosticReport.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "DiagnosticReport.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "DiagnosticReport.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "DiagnosticReport.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "DiagnosticReport.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "alias": [ "ReportID", "Filler ID", "Placer ID" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport.identifier" }, "comment": "Usually assigned by the Information System of the diagnostic service provider (filler id).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifiers assigned to this report by the performer or other systems.", "id": "DiagnosticReport.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "OBR-51/ for globally unique filler ID - OBR-3 , For non-globally unique filler-id the flller/placer number must be combined with the universal service Id - OBR-2(if present)+OBR-3+OBR-4" }, { "identity": "rim", "map": "id" } ], "max": "*", "min": 0, "path": "DiagnosticReport.identifier", "requirements": "Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context.", "short": "Business identifier for report", "type": [ { "code": "Identifier" } ] }, { "alias": [ "Request" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport.basedOn" }, "comment": "Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Details concerning a service requested.", "id": "DiagnosticReport.basedOn", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "ORC? OBR-2/3?" }, { "identity": "rim", "map": "outboundRelationship[typeCode=FLFS].target" } ], "max": "1", "min": 0, "path": "DiagnosticReport.basedOn", "requirements": "This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon.", "short": "What was requested", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ServiceRequestOH" ] } ] }, { "base": { "max": "1", "min": 1, "path": "DiagnosticReport.status" }, "binding": { "description": "The status of the diagnostic report.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DiagnosticReportStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status of the diagnostic report.", "id": "DiagnosticReport.status", "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, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "v2", "map": "OBR-25 (not 1:1 mapping)" }, { "identity": "rim", "map": "statusCode Note: final and amended are distinguished by whether observation is the subject of a ControlAct event of type \"revise\"" } ], "max": "1", "min": 1, "path": "DiagnosticReport.status", "requirements": "Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports.", "short": "registered | partial | preliminary | final +", "type": [ { "code": "code" } ] }, { "alias": [ "Department", "Sub-department", "Service", "Discipline" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport.category" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections" }, "comment": "Multiple categories are allowed using various categorization schemes. 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 DiagnosticReport.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.", "id": "DiagnosticReport.category", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "v2", "map": "OBR-24" }, { "identity": "rim", "map": "inboundRelationship[typeCode=COMP].source[classCode=LIST, moodCode=EVN, code < LabService].code" } ], "max": "1", "min": 1, "path": "DiagnosticReport.category", "short": "Service category", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DiagnosticReport.category.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DiagnosticReport.category.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.category.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DiagnosticReport.category.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "DiagnosticReport.category.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "DiagnosticReport.category.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DiagnosticReport.category.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DiagnosticReport.category.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.category.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DiagnosticReport.category.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "DiagnosticReport.category.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "DiagnosticReport.category.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "DiagnosticReport.category.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "DiagnosticReport.category.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "DiagnosticReport.category.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "DiagnosticReport.category.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DiagnosticReport.category.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "DiagnosticReport.category.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "DiagnosticReport.category.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "DiagnosticReport.category.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DiagnosticReport.category.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "DiagnosticReport.category.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "Type" ], "base": { "max": "1", "min": 1, "path": "DiagnosticReport.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/report-codes" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code or name that describes this diagnostic report.", "id": "DiagnosticReport.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "v2", "map": "OBR-4 (HL7 v2 doesn't provide an easy way to indicate both the ordered test and the performed panel)" }, { "identity": "rim", "map": "code" } ], "max": "1", "min": 1, "path": "DiagnosticReport.code", "short": "Name/Code for this diagnostic report", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DiagnosticReport.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DiagnosticReport.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DiagnosticReport.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "DiagnosticReport.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "DiagnosticReport.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DiagnosticReport.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DiagnosticReport.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DiagnosticReport.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "DiagnosticReport.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "DiagnosticReport.code.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "DiagnosticReport.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "DiagnosticReport.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "DiagnosticReport.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "DiagnosticReport.code.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DiagnosticReport.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "DiagnosticReport.code.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "DiagnosticReport.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "DiagnosticReport.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DiagnosticReport.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "DiagnosticReport.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "Patient" ], "base": { "max": "1", "min": 0, "path": "DiagnosticReport.subject" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.", "id": "DiagnosticReport.subject", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "v2", "map": "PID-3 (no HL7 v2 mapping for Group or Device)" }, { "identity": "rim", "map": "participation[typeCode=SBJ]" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 1, "path": "DiagnosticReport.subject", "requirements": "SHALL know the subject context.", "short": "The subject of the report - usually, but not always, the patient", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "alias": [ "Context" ], "base": { "max": "1", "min": 0, "path": "DiagnosticReport.encounter" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.", "id": "DiagnosticReport.encounter", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.encounter" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "v2", "map": "PV1-19" }, { "identity": "rim", "map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" } ], "max": "1", "min": 0, "path": "DiagnosticReport.encounter", "requirements": "Links the request to the Encounter context.", "short": "Health care event when test ordered", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "alias": [ "Observation time", "Effective Time", "Occurrence" ], "base": { "max": "1", "min": 0, "path": "DiagnosticReport.effective[x]" }, "comment": "If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.", "id": "DiagnosticReport.effective[x]", "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" } ], "max": "1", "min": 1, "path": "DiagnosticReport.effective[x]", "requirements": "Need to know where in the patient history to file/present this report.", "short": "Diagnostically relevant time (typically the time of specimen collection)", "type": [ { "code": "dateTime" } ] }, { "alias": [ "Date published", "Date Issued", "Date Verified" ], "base": { "max": "1", "min": 0, "path": "DiagnosticReport.issued" }, "comment": "May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.", "id": "DiagnosticReport.issued", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.recorded" }, { "identity": "v2", "map": "OBR-22" }, { "identity": "rim", "map": "participation[typeCode=VRF or AUT].time" } ], "max": "1", "min": 1, "path": "DiagnosticReport.issued", "requirements": "Clinicians need to be able to check the date that the report was released.", "short": "When the report was released", "type": [ { "code": "instant" } ] }, { "alias": [ "Laboratory", "Service", "Practitioner", "Department", "Company", "Authorized by", "Director" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport.performer" }, "comment": "This is not necessarily the source of the atomic data items or the entity that interpreted the results. It is the entity that takes responsibility for the clinical report.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The diagnostic service that is responsible for issuing the report.", "id": "DiagnosticReport.performer", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "v2", "map": "PRT-8 (where this PRT-4-Participation = \"PO\")" }, { "identity": "rim", "map": ".participation[typeCode=PRF]" } ], "max": "*", "min": 1, "path": "DiagnosticReport.performer", "requirements": "Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis.", "short": "Responsible Diagnostic Service", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "alias": [ "Analyzed by", "Reported by" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport.resultsInterpreter" }, "comment": "Might not be the same entity that takes responsibility for the clinical report.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The practitioner or organization that is responsible for the report's conclusions and interpretations.", "id": "DiagnosticReport.resultsInterpreter", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "v2", "map": "OBR-32, PRT-8 (where this PRT-4-Participation = \"PI\")" }, { "identity": "rim", "map": ".participation[typeCode=PRF]" } ], "max": "*", "min": 1, "path": "DiagnosticReport.resultsInterpreter", "requirements": "Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis.", "short": "Primary result interpreter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "DiagnosticReport.specimen" }, "comment": "If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Details about the specimens on which this diagnostic report is based.", "id": "DiagnosticReport.specimen", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "SPM" }, { "identity": "rim", "map": "participation[typeCode=SBJ]" } ], "max": "*", "min": 0, "path": "DiagnosticReport.specimen", "requirements": "Need to be able to report information about the collected specimens on which the report is based.", "short": "Specimens this report is based on", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ] }, { "alias": [ "Data", "Atomic Value", "Result", "Atomic result", "Data", "Test", "Analyte", "Battery", "Organizer" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport.result" }, "comment": "Observations can contain observations.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "[Observations](observation.html) that are part of this diagnostic report.", "id": "DiagnosticReport.result", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBXs" }, { "identity": "rim", "map": "outboundRelationship[typeCode=COMP].target" } ], "max": "0", "min": 0, "path": "DiagnosticReport.result", "requirements": "Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful.", "short": "Observations", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation" ] } ] }, { "base": { "max": "*", "min": 0, "path": "DiagnosticReport.imagingStudy" }, "comment": "ImagingStudy and the image element are somewhat overlapping - typically, the list of image references in the image element will also be found in one of the imaging study resources. However, each caters to different types of displays for different types of purposes. Neither, either, or both may be provided.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.", "id": "DiagnosticReport.imagingStudy", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=COMP].target[classsCode=DGIMG, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "DiagnosticReport.imagingStudy", "short": "Reference to full details of imaging associated with the diagnostic report", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ImagingStudy" ] } ] }, { "alias": [ "DICOM", "Slides", "Scans" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport.media" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).", "id": "DiagnosticReport.media", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX?" }, { "identity": "rim", "map": "outboundRelationship[typeCode=COMP].target" } ], "max": "0", "min": 0, "path": "DiagnosticReport.media", "requirements": "Many diagnostic services include images in the report as part of their service.", "short": "Key images associated with this report", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DiagnosticReport.media.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DiagnosticReport.media.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.media.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DiagnosticReport.media.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "DiagnosticReport.media.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "DiagnosticReport.media.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "DiagnosticReport.media.comment" }, "comment": "The comment should be displayed with the image. It would be common for the report to include additional discussion of the image contents in other sections such as the conclusion.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.", "id": "DiagnosticReport.media.comment", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" } ], "max": "1", "min": 0, "path": "DiagnosticReport.media.comment", "requirements": "The provider of the report should make a comment about each image included in the report.", "short": "Comment about the image (e.g. explanation)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 1, "path": "DiagnosticReport.media.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Reference to the image source.", "id": "DiagnosticReport.media.link", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".value.reference" } ], "max": "1", "min": 1, "path": "DiagnosticReport.media.link", "short": "Reference to the image source", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Media" ] } ] }, { "alias": [ "Report" ], "base": { "max": "1", "min": 0, "path": "DiagnosticReport.conclusion" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.", "id": "DiagnosticReport.conclusion", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": "inboundRelationship[typeCode=\"SPRT\"].source[classCode=OBS, moodCode=EVN, code=LOINC:48767-8].value (type=ST)" } ], "max": "1", "min": 0, "path": "DiagnosticReport.conclusion", "requirements": "Need to be able to provide a conclusion that is not lost among the basic result data.", "short": "Clinical conclusion (interpretation) of test results", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "DiagnosticReport.conclusionCode" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.", "id": "DiagnosticReport.conclusionCode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": "inboundRelationship[typeCode=SPRT].source[classCode=OBS, moodCode=EVN, code=LOINC:54531-9].value (type=CD)" } ], "max": "*", "min": 0, "path": "DiagnosticReport.conclusionCode", "short": "Codes for the clinical conclusion of test results", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DiagnosticReport.conclusionCode.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DiagnosticReport.conclusionCode.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.conclusionCode.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DiagnosticReport.conclusionCode.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "DiagnosticReport.conclusionCode.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "DiagnosticReport.conclusionCode.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DiagnosticReport.conclusionCode.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DiagnosticReport.conclusionCode.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.conclusionCode.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DiagnosticReport.conclusionCode.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "DiagnosticReport.conclusionCode.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "DiagnosticReport.conclusionCode.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "DiagnosticReport.conclusionCode.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "DiagnosticReport.conclusionCode.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "DiagnosticReport.conclusionCode.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "DiagnosticReport.conclusionCode.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DiagnosticReport.conclusionCode.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "DiagnosticReport.conclusionCode.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "DiagnosticReport.conclusionCode.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "DiagnosticReport.conclusionCode.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DiagnosticReport.conclusionCode.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "DiagnosticReport.conclusionCode.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "DiagnosticReport.presentedForm" }, "comment": "\"application/pdf\" is recommended as the most reliable and interoperable in this context.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.", "id": "DiagnosticReport.presentedForm", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": "text (type=ED)" } ], "max": "*", "min": 0, "path": "DiagnosticReport.presentedForm", "requirements": "Gives laboratory the ability to provide its own fully formatted report for clinical fidelity.", "short": "Entire report as issued", "type": [ { "code": "Attachment" } ] } ] }, "status": "draft", "title": "OneHealth Diagnostic Report Note Exchange", "type": "DiagnosticReport", "url": "https://fhir.onehealth.com.pe/StructureDefinition/DiagnosticReportNoteExchangeOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/DiagnosticReportLaboratoryOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR DiagnosticReportLaboratoryOH Profile, for OH interoperability scenarios, based on the national CORE DiagnosticReport Profile defined by HL7 OH.", "differential": { "element": [ { "id": "DiagnosticReport.basedOn", "max": "1", "path": "DiagnosticReport.basedOn", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ServiceRequestOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections" }, "id": "DiagnosticReport.category", "max": "1", "min": 1, "path": "DiagnosticReport.category" }, { "id": "DiagnosticReport.category.coding.system", "min": 1, "path": "DiagnosticReport.category.coding.system", "patternUri": "http://terminology.hl7.org/CodeSystem/v2-0074" }, { "id": "DiagnosticReport.category.coding.version", "max": "0", "path": "DiagnosticReport.category.coding.version" }, { "fixedCode": "LAB", "id": "DiagnosticReport.category.coding.code", "min": 1, "path": "DiagnosticReport.category.coding.code" }, { "id": "DiagnosticReport.category.coding.display", "min": 1, "path": "DiagnosticReport.category.coding.display", "patternString": "Laboratory" }, { "id": "DiagnosticReport.category.coding.userSelected", "max": "0", "path": "DiagnosticReport.category.coding.userSelected" }, { "id": "DiagnosticReport.category.text", "max": "0", "path": "DiagnosticReport.category.text" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/report-codes" }, "id": "DiagnosticReport.code", "path": "DiagnosticReport.code" }, { "id": "DiagnosticReport.code.coding.system", "min": 1, "path": "DiagnosticReport.code.coding.system" }, { "id": "DiagnosticReport.code.coding.version", "max": "0", "path": "DiagnosticReport.code.coding.version" }, { "id": "DiagnosticReport.code.coding.code", "min": 1, "path": "DiagnosticReport.code.coding.code" }, { "id": "DiagnosticReport.code.coding.display", "min": 1, "path": "DiagnosticReport.code.coding.display" }, { "id": "DiagnosticReport.code.coding.userSelected", "max": "0", "path": "DiagnosticReport.code.coding.userSelected" }, { "id": "DiagnosticReport.code.text", "max": "0", "path": "DiagnosticReport.code.text" }, { "id": "DiagnosticReport.subject", "min": 1, "path": "DiagnosticReport.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "DiagnosticReport.encounter", "path": "DiagnosticReport.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "id": "DiagnosticReport.effective[x]", "min": 1, "path": "DiagnosticReport.effective[x]", "short": "Diagnostically relevant time (typically the time of specimen collection)", "type": [ { "code": "dateTime" } ] }, { "id": "DiagnosticReport.issued", "min": 1, "path": "DiagnosticReport.issued", "short": "When the report was released" }, { "id": "DiagnosticReport.performer", "min": 1, "path": "DiagnosticReport.performer", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "DiagnosticReport.resultsInterpreter", "min": 1, "path": "DiagnosticReport.resultsInterpreter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "DiagnosticReport.specimen", "max": "0", "path": "DiagnosticReport.specimen" }, { "id": "DiagnosticReport.result", "min": 1, "path": "DiagnosticReport.result", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBasicLaboratoryOH" ] } ] }, { "id": "DiagnosticReport.imagingStudy", "max": "0", "path": "DiagnosticReport.imagingStudy" }, { "id": "DiagnosticReport.media", "max": "0", "path": "DiagnosticReport.media" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings" }, "id": "DiagnosticReport.conclusionCode", "path": "DiagnosticReport.conclusionCode" }, { "id": "DiagnosticReport.conclusionCode.coding.system", "min": 1, "path": "DiagnosticReport.conclusionCode.coding.system" }, { "id": "DiagnosticReport.conclusionCode.coding.version", "max": "0", "path": "DiagnosticReport.conclusionCode.coding.version" }, { "id": "DiagnosticReport.conclusionCode.coding.code", "min": 1, "path": "DiagnosticReport.conclusionCode.coding.code" }, { "id": "DiagnosticReport.conclusionCode.coding.display", "min": 1, "path": "DiagnosticReport.conclusionCode.coding.display" }, { "id": "DiagnosticReport.conclusionCode.coding.userSelected", "max": "0", "path": "DiagnosticReport.conclusionCode.coding.userSelected" }, { "id": "DiagnosticReport.conclusionCode.text", "max": "0", "path": "DiagnosticReport.conclusionCode.text" } ] }, "fhirVersion": "4.0.1", "id": "DiagnosticReportLaboratoryOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" } ], "meta": { "lastUpdated": "2024-04-12T17:46:17.199395+00:00", "versionId": "MTcxMjk0Mzk3NzE5OTM5NTAwMA" }, "name": "DiagnosticReportLaboratoryOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Report", "Test", "Result", "Results", "Labs", "Laboratory" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport" }, "comment": "This is intended to capture a single report and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.", "id": "DiagnosticReport", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "v2", "map": "ORU -> OBR" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=EVN]" } ], "max": "*", "min": 0, "path": "DiagnosticReport", "short": "A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "DiagnosticReport.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "DiagnosticReport.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "DiagnosticReport.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "DiagnosticReport.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "DiagnosticReport.implicitRules", "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, "max": "1", "min": 0, "path": "DiagnosticReport.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "DiagnosticReport.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "DiagnosticReport.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "DiagnosticReport.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "DiagnosticReport.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "DiagnosticReport.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "DiagnosticReport.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "DiagnosticReport.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "DiagnosticReport.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "DiagnosticReport.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "alias": [ "ReportID", "Filler ID", "Placer ID" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport.identifier" }, "comment": "Usually assigned by the Information System of the diagnostic service provider (filler id).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifiers assigned to this report by the performer or other systems.", "id": "DiagnosticReport.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "OBR-51/ for globally unique filler ID - OBR-3 , For non-globally unique filler-id the flller/placer number must be combined with the universal service Id - OBR-2(if present)+OBR-3+OBR-4" }, { "identity": "rim", "map": "id" } ], "max": "*", "min": 0, "path": "DiagnosticReport.identifier", "requirements": "Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context.", "short": "Business identifier for report", "type": [ { "code": "Identifier" } ] }, { "alias": [ "Request" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport.basedOn" }, "comment": "Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Details concerning a service requested.", "id": "DiagnosticReport.basedOn", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "v2", "map": "ORC? OBR-2/3?" }, { "identity": "rim", "map": "outboundRelationship[typeCode=FLFS].target" } ], "max": "1", "min": 0, "path": "DiagnosticReport.basedOn", "requirements": "This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon.", "short": "What was requested", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ServiceRequestOH" ] } ] }, { "base": { "max": "1", "min": 1, "path": "DiagnosticReport.status" }, "binding": { "description": "The status of the diagnostic report.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DiagnosticReportStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status of the diagnostic report.", "id": "DiagnosticReport.status", "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, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "v2", "map": "OBR-25 (not 1:1 mapping)" }, { "identity": "rim", "map": "statusCode Note: final and amended are distinguished by whether observation is the subject of a ControlAct event of type \"revise\"" } ], "max": "1", "min": 1, "path": "DiagnosticReport.status", "requirements": "Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports.", "short": "registered | partial | preliminary | final +", "type": [ { "code": "code" } ] }, { "alias": [ "Department", "Sub-department", "Service", "Discipline" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport.category" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections" }, "comment": "Multiple categories are allowed using various categorization schemes. 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 DiagnosticReport.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.", "id": "DiagnosticReport.category", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "v2", "map": "OBR-24" }, { "identity": "rim", "map": "inboundRelationship[typeCode=COMP].source[classCode=LIST, moodCode=EVN, code < LabService].code" } ], "max": "1", "min": 1, "path": "DiagnosticReport.category", "short": "Service category", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DiagnosticReport.category.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DiagnosticReport.category.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.category.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DiagnosticReport.category.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "DiagnosticReport.category.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "DiagnosticReport.category.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DiagnosticReport.category.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DiagnosticReport.category.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.category.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DiagnosticReport.category.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "DiagnosticReport.category.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "DiagnosticReport.category.coding.system", "patternUri": "http://terminology.hl7.org/CodeSystem/v2-0074", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "DiagnosticReport.category.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "DiagnosticReport.category.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "fixedCode": "LAB", "id": "DiagnosticReport.category.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "DiagnosticReport.category.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DiagnosticReport.category.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "DiagnosticReport.category.coding.display", "patternString": "Laboratory", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "DiagnosticReport.category.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "DiagnosticReport.category.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DiagnosticReport.category.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "DiagnosticReport.category.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "Type" ], "base": { "max": "1", "min": 1, "path": "DiagnosticReport.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/report-codes" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code or name that describes this diagnostic report.", "id": "DiagnosticReport.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "v2", "map": "OBR-4 (HL7 v2 doesn't provide an easy way to indicate both the ordered test and the performed panel)" }, { "identity": "rim", "map": "code" } ], "max": "1", "min": 1, "path": "DiagnosticReport.code", "short": "Name/Code for this diagnostic report", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DiagnosticReport.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DiagnosticReport.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DiagnosticReport.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "DiagnosticReport.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "DiagnosticReport.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DiagnosticReport.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DiagnosticReport.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DiagnosticReport.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "DiagnosticReport.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "DiagnosticReport.code.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "DiagnosticReport.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "DiagnosticReport.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "DiagnosticReport.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "DiagnosticReport.code.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DiagnosticReport.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "DiagnosticReport.code.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "DiagnosticReport.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "DiagnosticReport.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DiagnosticReport.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "DiagnosticReport.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "Patient" ], "base": { "max": "1", "min": 0, "path": "DiagnosticReport.subject" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.", "id": "DiagnosticReport.subject", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "v2", "map": "PID-3 (no HL7 v2 mapping for Group or Device)" }, { "identity": "rim", "map": "participation[typeCode=SBJ]" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 1, "path": "DiagnosticReport.subject", "requirements": "SHALL know the subject context.", "short": "The subject of the report - usually, but not always, the patient", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "alias": [ "Context" ], "base": { "max": "1", "min": 0, "path": "DiagnosticReport.encounter" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.", "id": "DiagnosticReport.encounter", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.encounter" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "v2", "map": "PV1-19" }, { "identity": "rim", "map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" } ], "max": "1", "min": 0, "path": "DiagnosticReport.encounter", "requirements": "Links the request to the Encounter context.", "short": "Health care event when test ordered", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "alias": [ "Observation time", "Effective Time", "Occurrence" ], "base": { "max": "1", "min": 0, "path": "DiagnosticReport.effective[x]" }, "comment": "If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.", "id": "DiagnosticReport.effective[x]", "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" } ], "max": "1", "min": 1, "path": "DiagnosticReport.effective[x]", "requirements": "Need to know where in the patient history to file/present this report.", "short": "Diagnostically relevant time (typically the time of specimen collection)", "type": [ { "code": "dateTime" } ] }, { "alias": [ "Date published", "Date Issued", "Date Verified" ], "base": { "max": "1", "min": 0, "path": "DiagnosticReport.issued" }, "comment": "May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.", "id": "DiagnosticReport.issued", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.recorded" }, { "identity": "v2", "map": "OBR-22" }, { "identity": "rim", "map": "participation[typeCode=VRF or AUT].time" } ], "max": "1", "min": 1, "path": "DiagnosticReport.issued", "requirements": "Clinicians need to be able to check the date that the report was released.", "short": "When the report was released", "type": [ { "code": "instant" } ] }, { "alias": [ "Laboratory", "Service", "Practitioner", "Department", "Company", "Authorized by", "Director" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport.performer" }, "comment": "This is not necessarily the source of the atomic data items or the entity that interpreted the results. It is the entity that takes responsibility for the clinical report.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The diagnostic service that is responsible for issuing the report.", "id": "DiagnosticReport.performer", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "v2", "map": "PRT-8 (where this PRT-4-Participation = \"PO\")" }, { "identity": "rim", "map": ".participation[typeCode=PRF]" } ], "max": "*", "min": 1, "path": "DiagnosticReport.performer", "requirements": "Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis.", "short": "Responsible Diagnostic Service", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "alias": [ "Analyzed by", "Reported by" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport.resultsInterpreter" }, "comment": "Might not be the same entity that takes responsibility for the clinical report.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The practitioner or organization that is responsible for the report's conclusions and interpretations.", "id": "DiagnosticReport.resultsInterpreter", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "v2", "map": "OBR-32, PRT-8 (where this PRT-4-Participation = \"PI\")" }, { "identity": "rim", "map": ".participation[typeCode=PRF]" } ], "max": "*", "min": 1, "path": "DiagnosticReport.resultsInterpreter", "requirements": "Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis.", "short": "Primary result interpreter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "DiagnosticReport.specimen" }, "comment": "If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Details about the specimens on which this diagnostic report is based.", "id": "DiagnosticReport.specimen", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "SPM" }, { "identity": "rim", "map": "participation[typeCode=SBJ]" } ], "max": "0", "min": 0, "path": "DiagnosticReport.specimen", "requirements": "Need to be able to report information about the collected specimens on which the report is based.", "short": "Specimens this report is based on", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ] } ] }, { "alias": [ "Data", "Atomic Value", "Result", "Atomic result", "Data", "Test", "Analyte", "Battery", "Organizer" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport.result" }, "comment": "Observations can contain observations.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "[Observations](observation.html) that are part of this diagnostic report.", "id": "DiagnosticReport.result", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBXs" }, { "identity": "rim", "map": "outboundRelationship[typeCode=COMP].target" } ], "max": "*", "min": 1, "path": "DiagnosticReport.result", "requirements": "Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful.", "short": "Observations", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBasicLaboratoryOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "DiagnosticReport.imagingStudy" }, "comment": "ImagingStudy and the image element are somewhat overlapping - typically, the list of image references in the image element will also be found in one of the imaging study resources. However, each caters to different types of displays for different types of purposes. Neither, either, or both may be provided.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.", "id": "DiagnosticReport.imagingStudy", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=COMP].target[classsCode=DGIMG, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "DiagnosticReport.imagingStudy", "short": "Reference to full details of imaging associated with the diagnostic report", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ImagingStudy" ] } ] }, { "alias": [ "DICOM", "Slides", "Scans" ], "base": { "max": "*", "min": 0, "path": "DiagnosticReport.media" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).", "id": "DiagnosticReport.media", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "OBX?" }, { "identity": "rim", "map": "outboundRelationship[typeCode=COMP].target" } ], "max": "0", "min": 0, "path": "DiagnosticReport.media", "requirements": "Many diagnostic services include images in the report as part of their service.", "short": "Key images associated with this report", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DiagnosticReport.media.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DiagnosticReport.media.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.media.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DiagnosticReport.media.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "DiagnosticReport.media.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "DiagnosticReport.media.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "DiagnosticReport.media.comment" }, "comment": "The comment should be displayed with the image. It would be common for the report to include additional discussion of the image contents in other sections such as the conclusion.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.", "id": "DiagnosticReport.media.comment", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" } ], "max": "1", "min": 0, "path": "DiagnosticReport.media.comment", "requirements": "The provider of the report should make a comment about each image included in the report.", "short": "Comment about the image (e.g. explanation)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 1, "path": "DiagnosticReport.media.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Reference to the image source.", "id": "DiagnosticReport.media.link", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".value.reference" } ], "max": "1", "min": 1, "path": "DiagnosticReport.media.link", "short": "Reference to the image source", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Media" ] } ] }, { "alias": [ "Report" ], "base": { "max": "1", "min": 0, "path": "DiagnosticReport.conclusion" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.", "id": "DiagnosticReport.conclusion", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": "inboundRelationship[typeCode=\"SPRT\"].source[classCode=OBS, moodCode=EVN, code=LOINC:48767-8].value (type=ST)" } ], "max": "1", "min": 0, "path": "DiagnosticReport.conclusion", "requirements": "Need to be able to provide a conclusion that is not lost among the basic result data.", "short": "Clinical conclusion (interpretation) of test results", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "DiagnosticReport.conclusionCode" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.", "id": "DiagnosticReport.conclusionCode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": "inboundRelationship[typeCode=SPRT].source[classCode=OBS, moodCode=EVN, code=LOINC:54531-9].value (type=CD)" } ], "max": "*", "min": 0, "path": "DiagnosticReport.conclusionCode", "short": "Codes for the clinical conclusion of test results", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DiagnosticReport.conclusionCode.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DiagnosticReport.conclusionCode.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.conclusionCode.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DiagnosticReport.conclusionCode.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "DiagnosticReport.conclusionCode.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "DiagnosticReport.conclusionCode.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "DiagnosticReport.conclusionCode.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "DiagnosticReport.conclusionCode.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "DiagnosticReport.conclusionCode.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "DiagnosticReport.conclusionCode.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "DiagnosticReport.conclusionCode.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "DiagnosticReport.conclusionCode.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "DiagnosticReport.conclusionCode.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "DiagnosticReport.conclusionCode.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "DiagnosticReport.conclusionCode.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "DiagnosticReport.conclusionCode.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DiagnosticReport.conclusionCode.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "DiagnosticReport.conclusionCode.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "DiagnosticReport.conclusionCode.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "DiagnosticReport.conclusionCode.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "DiagnosticReport.conclusionCode.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "DiagnosticReport.conclusionCode.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "DiagnosticReport.presentedForm" }, "comment": "\"application/pdf\" is recommended as the most reliable and interoperable in this context.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.", "id": "DiagnosticReport.presentedForm", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX" }, { "identity": "rim", "map": "text (type=ED)" } ], "max": "*", "min": 0, "path": "DiagnosticReport.presentedForm", "requirements": "Gives laboratory the ability to provide its own fully formatted report for clinical fidelity.", "short": "Entire report as issued", "type": [ { "code": "Attachment" } ] } ] }, "status": "draft", "title": "OneHealth Diagnostic Report Laboratory", "type": "DiagnosticReport", "url": "https://fhir.onehealth.com.pe/StructureDefinition/DiagnosticReportLaboratoryOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/CoverageOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Coverage", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-02", "derivation": "constraint", "description": "FHIR CoverageOH Profile, for OH interoperability scenarios, based on the national CORE Coverage Profile defined by HL7 OH.", "differential": { "element": [ { "definition": "Business Identifier for the coverage. [ES: Ejemplo de udo: 12345678-01]", "id": "Coverage.identifier", "min": 1, "path": "Coverage.identifier", "short": "Business Identifier for the coverage. [ES: Ejemplo de udo: 12345678-01]" }, { "id": "Coverage.identifier.type", "max": "0", "path": "Coverage.identifier.type" }, { "id": "Coverage.identifier.assigner", "path": "Coverage.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/coverage-type" }, "id": "Coverage.type", "path": "Coverage.type" }, { "id": "Coverage.type.coding.system", "min": 1, "path": "Coverage.type.coding.system" }, { "id": "Coverage.type.coding.version", "max": "0", "path": "Coverage.type.coding.version" }, { "id": "Coverage.type.coding.code", "min": 1, "path": "Coverage.type.coding.code" }, { "id": "Coverage.type.coding.display", "min": 1, "path": "Coverage.type.coding.display" }, { "id": "Coverage.type.coding.userSelected", "max": "0", "path": "Coverage.type.coding.userSelected" }, { "id": "Coverage.type.text", "max": "0", "path": "Coverage.type.text" }, { "id": "Coverage.policyHolder", "path": "Coverage.policyHolder", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Coverage.subscriber", "min": 1, "path": "Coverage.subscriber", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "definition": "ID assigned to the subscriber. [ES: Ejemplo de udo: 12345678]", "id": "Coverage.subscriberId", "min": 1, "path": "Coverage.subscriberId", "short": "ID assigned to the subscriber. [ES: Ejemplo de udo: 12345678]" }, { "id": "Coverage.beneficiary", "path": "Coverage.beneficiary", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "definition": "Dependent number. [ES: Ejemplo de udo: 01]", "id": "Coverage.dependent", "min": 1, "path": "Coverage.dependent", "short": "Dependent number. [ES: Ejemplo de udo: 01]" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/subscriber-relationship" }, "id": "Coverage.relationship", "min": 1, "path": "Coverage.relationship" }, { "id": "Coverage.relationship.coding.version", "max": "0", "path": "Coverage.relationship.coding.version" }, { "id": "Coverage.relationship.coding.code", "min": 1, "path": "Coverage.relationship.coding.code" }, { "id": "Coverage.relationship.coding.display", "min": 1, "path": "Coverage.relationship.coding.display" }, { "id": "Coverage.relationship.coding.userSelected", "max": "0", "path": "Coverage.relationship.coding.userSelected" }, { "id": "Coverage.relationship.text", "max": "0", "path": "Coverage.relationship.text" }, { "id": "Coverage.payor", "path": "Coverage.payor", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Coverage.class", "min": 1, "path": "Coverage.class" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/coverage-class" }, "id": "Coverage.class.type", "path": "Coverage.class.type" }, { "id": "Coverage.class.type.coding.version", "max": "0", "path": "Coverage.class.type.coding.version" }, { "id": "Coverage.class.type.coding.code", "min": 1, "path": "Coverage.class.type.coding.code" }, { "id": "Coverage.class.type.coding.display", "min": 1, "path": "Coverage.class.type.coding.display" }, { "id": "Coverage.class.type.coding.userSelected", "max": "0", "path": "Coverage.class.type.coding.userSelected" }, { "id": "Coverage.class.type.text", "max": "0", "path": "Coverage.class.type.text" }, { "definition": "Value associated with the type [ES: valor de ejemplo \"EPS 100%\"]", "id": "Coverage.class.value", "path": "Coverage.class.value", "short": "Value associated with the type [ES: valor de ejemplo \"EPS 100%\"]" }, { "id": "Coverage.order", "max": "0", "path": "Coverage.order" }, { "id": "Coverage.network", "max": "0", "path": "Coverage.network" }, { "id": "Coverage.costToBeneficiary", "max": "0", "path": "Coverage.costToBeneficiary" }, { "id": "Coverage.subrogation", "max": "0", "path": "Coverage.subrogation" }, { "id": "Coverage.contract", "max": "0", "path": "Coverage.contract" } ] }, "fhirVersion": "4.0.1", "id": "CoverageOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "cdanetv4", "name": "Canadian Dental Association eclaims standard", "uri": "http://www.cda-adc.ca/en/services/cdanet/" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "cpha3pharm", "name": "Canadian Pharmacy Associaiton eclaims standard", "uri": "http://www.pharmacists.ca/" } ], "meta": { "lastUpdated": "2024-04-12T17:46:16.948653+00:00", "versionId": "MTcxMjk0Mzk3Njk0ODY1MzAwMA" }, "name": "CoverageOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Coverage" }, "comment": "The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.", "id": "Coverage", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "rim", "map": "Coverage" } ], "max": "*", "min": 0, "path": "Coverage", "short": "Insurance or medical plan or a payment agreement" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Coverage.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Coverage.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Coverage.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Coverage.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Coverage.implicitRules", "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, "max": "1", "min": 0, "path": "Coverage.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Coverage.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Coverage.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Coverage.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Coverage.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Coverage.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Coverage.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Coverage.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Coverage.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Coverage.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Coverage.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Coverage.identifier" }, "comment": "The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Business Identifier for the coverage. [ES: Ejemplo de udo: 12345678-01]", "id": "Coverage.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "cdanetv4", "map": "C02" }, { "identity": "v2", "map": "IN1-2" }, { "identity": "rim", "map": ".id" }, { "identity": "cpha3pharm", "map": "C.32, C.33, C.39" } ], "max": "*", "min": 1, "path": "Coverage.identifier", "requirements": "Allows coverages to be distinguished and referenced.", "short": "Business Identifier for the coverage. [ES: Ejemplo de udo: 12345678-01]", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Coverage.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Coverage.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Coverage.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Coverage.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "Coverage.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 0, "path": "Coverage.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "Coverage.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "Coverage.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "Coverage.identifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 0, "path": "Coverage.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "example": [ { "label": "General", "valueString": "123456" } ], "id": "Coverage.identifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 0, "path": "Coverage.identifier.value", "short": "The value that is unique", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "Coverage.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "1", "min": 0, "path": "Coverage.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "Coverage.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 0, "path": "Coverage.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Coverage.status" }, "binding": { "description": "A code specifying the state of the resource instance.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CoverageStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/fm-status|4.0.1" }, "comment": "This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status of the resource instance.", "id": "Coverage.status", "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, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": "Act.status" } ], "max": "1", "min": 1, "path": "Coverage.status", "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'.", "short": "active | cancelled | draft | entered-in-error", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coverage.type" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/coverage-type" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.", "id": "Coverage.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "v2", "map": "IN1-15" } ], "max": "1", "min": 0, "path": "Coverage.type", "requirements": "The order of application of coverages is dependent on the types of coverage.", "short": "Coverage category such as medical or accident", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Coverage.type.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Coverage.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Coverage.type.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Coverage.type.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Coverage.type.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Coverage.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Coverage.type.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Coverage.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Coverage.type.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Coverage.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Coverage.type.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Coverage.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Coverage.type.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Coverage.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Coverage.type.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Coverage.type.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Coverage.type.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Coverage.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Coverage.type.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Coverage.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Coverage.type.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Coverage.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coverage.policyHolder" }, "comment": "For example: may be an individual, corporation or the subscriber's employer.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The party who 'owns' the insurance policy.", "id": "Coverage.policyHolder", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "cdanetv4", "map": "D01 through D09" }, { "identity": "v2", "map": "IN1-16, 18, 19-name of insured, address, date of birth" }, { "identity": "cpha3pharm", "map": "C.35" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 0, "path": "Coverage.policyHolder", "requirements": "This provides employer information in the case of Worker's Compensation and other policies.", "short": "Owner of the policy", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Coverage.subscriber" }, "comment": "May be self or a parent in the case of dependants.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.", "id": "Coverage.subscriber", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "cdanetv4", "map": "D01 through D09" }, { "identity": "v2", "map": "IN1-16, 18, 19-name of insured, address, date of birth" }, { "identity": "cpha3pharm", "map": "C.35" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 1, "path": "Coverage.subscriber", "requirements": "This is the party who is entitled to the benfits under the policy.", "short": "Subscriber to the policy", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Coverage.subscriberId" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "ID assigned to the subscriber. [ES: Ejemplo de udo: 12345678]", "id": "Coverage.subscriberId", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "cdanetv4", "map": "D01 through D09" }, { "identity": "v2", "map": "IN1-16, 18, 19-name of insured, address, date of birth" }, { "identity": "cpha3pharm", "map": "C.35" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 1, "path": "Coverage.subscriberId", "requirements": "The insurer requires this identifier on correspondance and claims (digital and otherwise).", "short": "ID assigned to the subscriber. [ES: Ejemplo de udo: 12345678]", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 1, "path": "Coverage.beneficiary" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The party who benefits from the insurance coverage; the patient when products and/or services are provided.", "id": "Coverage.beneficiary", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "cdanetv4", "map": "D01 through D09" }, { "identity": "v2", "map": "IN1-16, 18, 19-name of insured, address, date of birth" }, { "identity": "cpha3pharm", "map": "C.35" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 1, "path": "Coverage.beneficiary", "requirements": "This is the party who receives treatment for which the costs are reimbursed under the coverage.", "short": "Plan beneficiary", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Coverage.dependent" }, "comment": "Periodically the member number is constructed from the subscriberId and the dependant number.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Dependent number. [ES: Ejemplo de udo: 01]", "id": "Coverage.dependent", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "cdanetv4", "map": "C17" }, { "identity": "v2", "map": "- No exact HL7 v2 equivalent concept seems to exist;" } ], "max": "1", "min": 1, "path": "Coverage.dependent", "requirements": "For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary.", "short": "Dependent number. [ES: Ejemplo de udo: 01]", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coverage.relationship" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/subscriber-relationship" }, "comment": "Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The relationship of beneficiary (patient) to the subscriber.", "id": "Coverage.relationship", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "cdanetv4", "map": "C03" } ], "max": "1", "min": 1, "path": "Coverage.relationship", "requirements": "To determine relationship between the patient and the subscriber to determine coordination of benefits.", "short": "Beneficiary relationship to the subscriber", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Coverage.relationship.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Coverage.relationship.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Coverage.relationship.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Coverage.relationship.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Coverage.relationship.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Coverage.relationship.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Coverage.relationship.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Coverage.relationship.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Coverage.relationship.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Coverage.relationship.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Coverage.relationship.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 0, "path": "Coverage.relationship.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Coverage.relationship.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Coverage.relationship.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Coverage.relationship.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Coverage.relationship.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Coverage.relationship.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Coverage.relationship.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Coverage.relationship.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Coverage.relationship.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Coverage.relationship.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Coverage.relationship.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coverage.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.", "id": "Coverage.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "v2", "map": "IN1-12 / IN1-13" }, { "identity": "rim", "map": "Act.effectiveTime" } ], "max": "1", "min": 0, "path": "Coverage.period", "requirements": "Some insurers require the submission of the coverage term.", "short": "Coverage start and end dates", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 1, "path": "Coverage.payor" }, "comment": "May provide multiple identifiers such as insurance company identifier or business identifier (BIN number).\nFor selfpay it may provide multiple paying persons and/or organizations.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.", "id": "Coverage.payor", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.author" }, { "identity": "cdanetv4", "map": "A05" }, { "identity": "v2", "map": "IN1-3" }, { "identity": "cpha3pharm", "map": "C.30" } ], "max": "*", "min": 1, "path": "Coverage.payor", "requirements": "Need to identify the issuer to target for claim processing and for coordination of benefit processing.", "short": "Issuer of the policy", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Coverage.class" }, "comment": "For example may be used to identify a class of coverage or employer group, Policy, Plan.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A suite of underwriter specific classifiers.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Class" } ], "id": "Coverage.class", "isModifier": false, "isSummary": false, "max": "*", "min": 1, "path": "Coverage.class", "requirements": "The codes provided on the health card which identify or confirm the specific policy for the insurer.", "short": "Additional coverage classifications", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Coverage.class.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Coverage.class.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Coverage.class.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Coverage.class.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Coverage.class.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Coverage.class.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Coverage.class.type" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/coverage-class" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.", "id": "Coverage.class.type", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Coverage.class.type", "requirements": "The insurer issued label for a specific health card value.", "short": "Type of class such as 'group' or 'plan'", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Coverage.class.type.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Coverage.class.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Coverage.class.type.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Coverage.class.type.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Coverage.class.type.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "Coverage.class.type.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Coverage.class.type.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Coverage.class.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Coverage.class.type.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Coverage.class.type.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Coverage.class.type.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 0, "path": "Coverage.class.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Coverage.class.type.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Coverage.class.type.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Coverage.class.type.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Coverage.class.type.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Coverage.class.type.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Coverage.class.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Coverage.class.type.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Coverage.class.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Coverage.class.type.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Coverage.class.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 1, "path": "Coverage.class.value" }, "comment": "For example, the Group or Plan number.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Value associated with the type [ES: valor de ejemplo \"EPS 100%\"]", "id": "Coverage.class.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "cdanetv4", "map": "C11 (Division,Section)" }, { "identity": "v2", "map": "IN1-8" }, { "identity": "cpha3pharm", "map": "C.31" } ], "max": "1", "min": 1, "path": "Coverage.class.value", "requirements": "The insurer issued label and value are necessary to identify the specific policy.", "short": "Value associated with the type [ES: valor de ejemplo \"EPS 100%\"]", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coverage.class.name" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A short description for the class.", "id": "Coverage.class.name", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "cdanetv4", "map": "C11 (Division,Section)" }, { "identity": "v2", "map": "IN1-8" }, { "identity": "cpha3pharm", "map": "C.31" } ], "max": "1", "min": 0, "path": "Coverage.class.name", "requirements": "Used to provide a meaningful description in correspondence to the patient.", "short": "Human readable description of the type and value", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coverage.order" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.", "id": "Coverage.order", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "- No exact HL7 v2 equivalent concept seems to exist;" } ], "max": "0", "min": 0, "path": "Coverage.order", "requirements": "Used in managing the coordination of benefits.", "short": "Relative order of the coverage", "type": [ { "code": "positiveInt" } ] }, { "base": { "max": "1", "min": 0, "path": "Coverage.network" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.", "id": "Coverage.network", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "cdanetv4", "map": "D10" } ], "max": "0", "min": 0, "path": "Coverage.network", "requirements": "Used in referral for treatment and in claims processing.", "short": "Insurer network", "type": [ { "code": "string" } ] }, { "alias": [ "CoPay", "Deductible", "Exceptions" ], "base": { "max": "*", "min": 0, "path": "Coverage.costToBeneficiary" }, "comment": "For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "CostToBeneficiary" } ], "id": "Coverage.costToBeneficiary", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "Coverage.costToBeneficiary", "requirements": "Required by providers to manage financial transaction with the patient.", "short": "Patient payments for services/products", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Coverage.costToBeneficiary.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Coverage.costToBeneficiary.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Coverage.costToBeneficiary.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Coverage.costToBeneficiary.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Coverage.costToBeneficiary.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Coverage.costToBeneficiary.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coverage.costToBeneficiary.type" }, "binding": { "description": "The types of services to which patient copayments are specified.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CopayTypes" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/coverage-copay-type" }, "comment": "For example visit, specialist visits, emergency, inpatient care, etc.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The category of patient centric costs associated with treatment.", "id": "Coverage.costToBeneficiary.type", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Coverage.costToBeneficiary.type", "requirements": "Needed to identify the category associated with the amount for the patient.", "short": "Cost category", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 1, "path": "Coverage.costToBeneficiary.value[x]" }, "comment": "Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The amount due from the patient for the cost category.", "id": "Coverage.costToBeneficiary.value[x]", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "cdanetv4", "map": "C11 (Division,Section)" }, { "identity": "v2", "map": "IN1-8" }, { "identity": "cpha3pharm", "map": "C.31" } ], "max": "1", "min": 1, "path": "Coverage.costToBeneficiary.value[x]", "requirements": "Needed to identify the amount for the patient associated with the category.", "short": "The amount or percentage due from the beneficiary", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] }, { "code": "Money" } ] }, { "base": { "max": "*", "min": 0, "path": "Coverage.costToBeneficiary.exception" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A suite of codes indicating exceptions or reductions to patient costs and their effective periods.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Exemption" } ], "id": "Coverage.costToBeneficiary.exception", "isModifier": false, "isSummary": false, "max": "*", "min": 0, "path": "Coverage.costToBeneficiary.exception", "requirements": "Required by providers to manage financial transaction with the patient.", "short": "Exceptions for patient payments", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Coverage.costToBeneficiary.exception.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Coverage.costToBeneficiary.exception.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Coverage.costToBeneficiary.exception.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Coverage.costToBeneficiary.exception.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Coverage.costToBeneficiary.exception.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Coverage.costToBeneficiary.exception.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Coverage.costToBeneficiary.exception.type" }, "binding": { "description": "The types of exceptions from the part or full value of financial obligations such as copays.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CoverageFinancialException" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/coverage-financial-exception" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The code for the specific exception.", "id": "Coverage.costToBeneficiary.exception.type", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Coverage.costToBeneficiary.exception.type", "requirements": "Needed to identify the exception associated with the amount for the patient.", "short": "Exception category", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Coverage.costToBeneficiary.exception.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The timeframe during when the exception is in force.", "id": "Coverage.costToBeneficiary.exception.period", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Coverage.costToBeneficiary.exception.period", "requirements": "Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs.", "short": "The effective period of the exception", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Coverage.subrogation" }, "comment": "Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.", "id": "Coverage.subrogation", "isModifier": false, "isSummary": false, "max": "0", "min": 0, "path": "Coverage.subrogation", "requirements": "See definition for when to be used.", "short": "Reimbursement to insurer", "type": [ { "code": "boolean" } ] }, { "base": { "max": "*", "min": 0, "path": "Coverage.contract" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The policy(s) which constitute this insurance coverage.", "id": "Coverage.contract", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "cdanetv4", "map": "D01 through D09" }, { "identity": "v2", "map": "IN1-16, 18, 19" }, { "identity": "rim", "map": "n/a" }, { "identity": "cpha3pharm", "map": "C.35" } ], "max": "0", "min": 0, "path": "Coverage.contract", "requirements": "To reference the legally binding contract between the policy holder and the insurer.", "short": "Contract details", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Contract" ] } ] } ] }, "status": "draft", "title": "OneHealth Coverage", "type": "Coverage", "url": "https://fhir.onehealth.com.pe/StructureDefinition/CoverageOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/ConditionProblemListItemOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Condition", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2023-12-05", "derivation": "constraint", "description": "FHIR Condition Problem List Item Profile, for OH interoperability scenarios, based on the national CORE Condition Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Condition.identifier", "max": "1", "min": 1, "path": "Condition.identifier" }, { "id": "Condition.identifier.use", "max": "0", "path": "Condition.identifier.use" }, { "id": "Condition.identifier.type", "max": "0", "path": "Condition.identifier.type" }, { "id": "Condition.identifier.system", "min": 1, "path": "Condition.identifier.system" }, { "id": "Condition.identifier.value", "min": 1, "path": "Condition.identifier.value" }, { "id": "Condition.identifier.period", "max": "0", "path": "Condition.identifier.period" }, { "id": "Condition.identifier.assigner", "path": "Condition.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-clinical" }, "id": "Condition.clinicalStatus", "path": "Condition.clinicalStatus" }, { "id": "Condition.clinicalStatus.coding", "max": "1", "min": 1, "path": "Condition.clinicalStatus.coding" }, { "id": "Condition.clinicalStatus.coding.system", "min": 1, "path": "Condition.clinicalStatus.coding.system" }, { "id": "Condition.clinicalStatus.coding.version", "max": "0", "path": "Condition.clinicalStatus.coding.version" }, { "id": "Condition.clinicalStatus.coding.code", "min": 1, "path": "Condition.clinicalStatus.coding.code" }, { "id": "Condition.clinicalStatus.coding.display", "min": 1, "path": "Condition.clinicalStatus.coding.display" }, { "id": "Condition.clinicalStatus.coding.userSelected", "max": "0", "path": "Condition.clinicalStatus.coding.userSelected" }, { "id": "Condition.clinicalStatus.text", "max": "0", "path": "Condition.clinicalStatus.text" }, { "id": "Condition.verificationStatus.coding", "max": "1", "min": 1, "path": "Condition.verificationStatus.coding" }, { "id": "Condition.verificationStatus.coding.system", "min": 1, "path": "Condition.verificationStatus.coding.system" }, { "id": "Condition.verificationStatus.coding.version", "max": "0", "path": "Condition.verificationStatus.coding.version" }, { "id": "Condition.verificationStatus.coding.code", "min": 1, "path": "Condition.verificationStatus.coding.code" }, { "id": "Condition.verificationStatus.coding.display", "min": 1, "path": "Condition.verificationStatus.coding.display" }, { "id": "Condition.verificationStatus.coding.userSelected", "max": "0", "path": "Condition.verificationStatus.coding.userSelected" }, { "id": "Condition.verificationStatus.text", "max": "0", "path": "Condition.verificationStatus.text" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-category" }, "fixedCodeableConcept": { "coding": [ { "code": "problem-list-item", "display": "Problem List Item", "system": "http://terminology.hl7.org/CodeSystem/condition-category" } ] }, "id": "Condition.category", "max": "1", "min": 1, "path": "Condition.category" }, { "binding": { "description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConditionSeverity" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-severity" }, "id": "Condition.severity", "path": "Condition.severity" }, { "id": "Condition.severity.coding", "max": "1", "min": 1, "path": "Condition.severity.coding" }, { "id": "Condition.severity.coding.system", "min": 1, "path": "Condition.severity.coding.system" }, { "id": "Condition.severity.coding.version", "max": "0", "path": "Condition.severity.coding.version" }, { "id": "Condition.severity.coding.code", "min": 1, "path": "Condition.severity.coding.code" }, { "id": "Condition.severity.coding.display", "min": 1, "path": "Condition.severity.coding.display" }, { "id": "Condition.severity.coding.userSelected", "max": "0", "path": "Condition.severity.coding.userSelected" }, { "id": "Condition.severity.text", "max": "0", "path": "Condition.severity.text" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-code" }, "id": "Condition.code", "min": 1, "path": "Condition.code" }, { "id": "Condition.code.coding", "max": "1", "min": 1, "path": "Condition.code.coding" }, { "id": "Condition.code.coding.system", "min": 1, "path": "Condition.code.coding.system" }, { "id": "Condition.code.coding.version", "max": "0", "path": "Condition.code.coding.version" }, { "id": "Condition.code.coding.code", "min": 1, "path": "Condition.code.coding.code" }, { "id": "Condition.code.coding.display", "min": 1, "path": "Condition.code.coding.display" }, { "id": "Condition.code.coding.userSelected", "max": "0", "path": "Condition.code.coding.userSelected" }, { "id": "Condition.code.text", "max": "0", "path": "Condition.code.text" }, { "id": "Condition.bodySite", "max": "0", "path": "Condition.bodySite" }, { "id": "Condition.subject", "path": "Condition.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Condition.encounter", "path": "Condition.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "id": "Condition.recordedDate", "min": 1, "path": "Condition.recordedDate" }, { "id": "Condition.recorder", "min": 1, "path": "Condition.recorder", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "Condition.asserter", "max": "0", "path": "Condition.asserter" }, { "id": "Condition.stage", "max": "0", "path": "Condition.stage" }, { "id": "Condition.evidence", "max": "0", "path": "Condition.evidence" } ] }, "fhirVersion": "4.0.1", "id": "ConditionProblemListItemOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "sct-concept", "name": "SNOMED CT Concept Domain Binding", "uri": "http://snomed.info/conceptdomain" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "sct-attr", "name": "SNOMED CT Attribute Binding", "uri": "http://snomed.org/attributebinding" } ], "meta": { "lastUpdated": "2024-04-12T17:46:16.656102+00:00", "versionId": "MTcxMjk0Mzk3NjY1NjEwMjAwMA" }, "name": "ConditionProblemListItemOH", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Condition" }, "constraint": [ { "expression": "clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "Most systems will expect a clinicalStatus to be valued for problem-list-items that are managed over time, but might not need a clinicalStatus for point in time encounter-diagnosis." } ], "human": "Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item", "key": "con-3", "severity": "warning", "xpath": "exists(f:clinicalStatus) or exists(f:verificationStatus/f:coding/f:code/@value='entered-in-error') or not(exists(category[@value='problem-list-item']))" }, { "expression": "abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()", "human": "If condition is abated, then clinicalStatus must be either inactive, resolved, or remission", "key": "con-4", "severity": "error", "xpath": "not(exists(*[starts-with(local-name(.), 'abatement')])) or exists(f:clinicalStatus/f:coding[f:system/@value='http://terminology.hl7.org/CodeSystem/condition-clinical' and f:code/@value=('resolved', 'remission', 'inactive')])" }, { "expression": "verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()", "human": "Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error", "key": "con-5", "severity": "error", "xpath": "not(exists(f:verificationStatus/f:coding[f:system/@value='http://terminology.hl7.org/CodeSystem/condition-ver-status' and f:code/@value='entered-in-error'])) or not(exists(f:clinicalStatus))" }, { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.", "id": "Condition", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "sct-concept", "map": "< 243796009 |Situation with explicit context| : 246090004 |Associated finding| = ( ( < 404684003 |Clinical finding| MINUS ( << 420134006 |Propensity to adverse reactions| OR << 473010000 |Hypersensitivity condition| OR << 79899007 |Drug interaction| OR << 69449002 |Drug action| OR << 441742003 |Evaluation finding| OR << 307824009 |Administrative status| OR << 385356007 |Tumor stage finding|)) OR < 272379006 |Event|)" }, { "identity": "v2", "map": "PPR message" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value<Diagnosis]" } ], "max": "*", "min": 0, "path": "Condition", "short": "Detailed information about conditions, problems or diagnoses" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Condition.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Condition.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Condition.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Condition.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Condition.implicitRules", "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, "max": "1", "min": 0, "path": "Condition.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Condition.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Condition.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Condition.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Condition.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Condition.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Condition.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Condition.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Condition.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Condition.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.identifier" }, "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 a Person resource instance might share the same social insurance number.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", "id": "Condition.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": ".id" } ], "max": "1", "min": 1, "path": "Condition.identifier", "requirements": "Allows identification of the condition as it is known by various participating systems and in a way that remains consistent across servers.", "short": "External Ids for this condition", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "Condition.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "Condition.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "Condition.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "Condition.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "Condition.identifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 1, "path": "Condition.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "example": [ { "label": "General", "valueString": "123456" } ], "id": "Condition.identifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Condition.identifier.value", "short": "The value that is unique", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "Condition.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Condition.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "Condition.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 0, "path": "Condition.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.clinicalStatus" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-clinical" }, "comment": "The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.", "condition": [ "con-3", "con-4", "con-5" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The clinical status of the condition.", "id": "Condition.clinicalStatus", "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the status contains codes that mark the condition as no longer active.", "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "sct-concept", "map": "< 303105007 |Disease phases|" }, { "identity": "v2", "map": "PRB-14" }, { "identity": "rim", "map": "Observation ACT\n.inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"clinicalStatus\", moodCode=EVN].value" } ], "max": "1", "min": 0, "path": "Condition.clinicalStatus", "short": "active | recurrence | relapse | inactive | remission | resolved", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.clinicalStatus.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.clinicalStatus.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.clinicalStatus.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.clinicalStatus.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Condition.clinicalStatus.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Condition.clinicalStatus.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.clinicalStatus.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.clinicalStatus.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.clinicalStatus.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.clinicalStatus.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Condition.clinicalStatus.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Condition.clinicalStatus.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Condition.clinicalStatus.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Condition.clinicalStatus.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Condition.clinicalStatus.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Condition.clinicalStatus.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.clinicalStatus.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Condition.clinicalStatus.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Condition.clinicalStatus.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Condition.clinicalStatus.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.clinicalStatus.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Condition.clinicalStatus.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.verificationStatus" }, "binding": { "description": "The verification status to support or decline the clinical status of the condition or diagnosis.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConditionVerificationStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1" }, "comment": "verificationStatus is not required. For example, when a patient has abdominal pain in the ED, there is not likely going to be a verification status.\nThe data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.", "condition": [ "con-3", "con-5" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The verification status to support the clinical status of the condition.", "id": "Condition.verificationStatus", "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the status contains the code refuted and entered-in-error that mark the Condition as not currently valid.", "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "sct-concept", "map": "< 410514004 |Finding context value|" }, { "identity": "v2", "map": "PRB-13" }, { "identity": "rim", "map": "Observation ACT\n.inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"verificationStatus\", moodCode=EVN].value" }, { "identity": "sct-attr", "map": "408729009" } ], "max": "1", "min": 0, "path": "Condition.verificationStatus", "short": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.verificationStatus.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.verificationStatus.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.verificationStatus.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.verificationStatus.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Condition.verificationStatus.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Condition.verificationStatus.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.verificationStatus.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.verificationStatus.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.verificationStatus.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.verificationStatus.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Condition.verificationStatus.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Condition.verificationStatus.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Condition.verificationStatus.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Condition.verificationStatus.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Condition.verificationStatus.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Condition.verificationStatus.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.verificationStatus.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Condition.verificationStatus.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Condition.verificationStatus.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Condition.verificationStatus.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.verificationStatus.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Condition.verificationStatus.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.category" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-category" }, "comment": "The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A category assigned to the condition.", "fixedCodeableConcept": { "coding": [ { "code": "problem-list-item", "display": "Problem List Item", "system": "http://terminology.hl7.org/CodeSystem/condition-category" } ] }, "id": "Condition.category", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "sct-concept", "map": "< 404684003 |Clinical finding|" }, { "identity": "v2", "map": "'problem' if from PRB-3. 'diagnosis' if from DG1 segment in PV1 message" }, { "identity": "rim", "map": ".code" } ], "max": "1", "min": 1, "path": "Condition.category", "short": "problem-list-item | encounter-diagnosis", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.severity" }, "binding": { "description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConditionSeverity" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-severity" }, "comment": "Coding of the severity with a terminology is preferred, where possible.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A subjective assessment of the severity of the condition as evaluated by the clinician.", "id": "Condition.severity", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.grade" }, { "identity": "sct-concept", "map": "< 272141005 |Severities|" }, { "identity": "v2", "map": "PRB-26 / ABS-3" }, { "identity": "rim", "map": "Can be pre/post-coordinated into value. Or ./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"severity\"].value" }, { "identity": "sct-attr", "map": "246112005" } ], "max": "1", "min": 0, "path": "Condition.severity", "short": "Subjective severity of condition", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.severity.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.severity.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.severity.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.severity.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Condition.severity.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Condition.severity.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.severity.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.severity.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.severity.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.severity.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Condition.severity.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Condition.severity.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Condition.severity.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Condition.severity.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Condition.severity.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Condition.severity.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.severity.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Condition.severity.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Condition.severity.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Condition.severity.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.severity.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Condition.severity.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "type" ], "base": { "max": "1", "min": 0, "path": "Condition.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identification of the condition, problem or diagnosis.", "id": "Condition.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "sct-concept", "map": "code 246090004 |Associated finding| (< 404684003 |Clinical finding| MINUS\n<< 420134006 |Propensity to adverse reactions| MINUS \n<< 473010000 |Hypersensitivity condition| MINUS \n<< 79899007 |Drug interaction| MINUS\n<< 69449002 |Drug action| MINUS \n<< 441742003 |Evaluation finding| MINUS \n<< 307824009 |Administrative status| MINUS \n<< 385356007 |Tumor stage finding|) \nOR < 413350009 |Finding with explicit context|\nOR < 272379006 |Event|" }, { "identity": "v2", "map": "PRB-3" }, { "identity": "rim", "map": ".value" }, { "identity": "sct-attr", "map": "246090004" } ], "max": "1", "min": 1, "path": "Condition.code", "requirements": "0..1 to account for primarily narrative only resources.", "short": "Identification of the condition, problem or diagnosis", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Condition.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Condition.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Condition.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Condition.code.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Condition.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Condition.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Condition.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Condition.code.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Condition.code.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Condition.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Condition.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Condition.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.bodySite" }, "binding": { "description": "Codes describing anatomical locations. May include laterality.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-site" }, "comment": "Only used if not implicit in code found in Condition.code. 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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The anatomical location where this condition manifests itself.", "id": "Condition.bodySite", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "sct-concept", "map": "< 442083009 |Anatomical or acquired body structure|" }, { "identity": "rim", "map": ".targetBodySiteCode" }, { "identity": "sct-attr", "map": "363698007" } ], "max": "0", "min": 0, "path": "Condition.bodySite", "short": "Anatomical location, if relevant", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "patient" ], "base": { "max": "1", "min": 1, "path": "Condition.subject" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the patient or group who the condition record is associated with.", "id": "Condition.subject", "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[classCode=PAT]" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 1, "path": "Condition.subject", "requirements": "Group is typically used for veterinary or public health use cases.", "short": "Who has the condition?", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.encounter" }, "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. This record indicates the encounter this particular record is associated with. In the case of a \"new\" diagnosis reflecting ongoing/revised information about the condition, this might be distinct from the first encounter in which the underlying condition was first \"known\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Encounter during which this Condition was created or to which the creation of this record is tightly associated.", "id": "Condition.encounter", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.context" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "v2", "map": "PV1-19 (+PV1-54)" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" } ], "max": "1", "min": 0, "path": "Condition.encounter", "short": "Encounter created as part of", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.onset[x]" }, "comment": "Age is generally used when the patient reports an age at which the Condition began to occur.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Estimated or actual date or date-time the condition began, in the opinion of the clinician.", "id": "Condition.onset[x]", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.init" }, { "identity": "v2", "map": "PRB-16" }, { "identity": "rim", "map": ".effectiveTime.low or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age at onset\"].value" } ], "max": "1", "min": 0, "path": "Condition.onset[x]", "short": "Estimated or actual date, date-time, or age", "type": [ { "code": "dateTime" }, { "code": "Age" }, { "code": "Period" }, { "code": "Range" }, { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.abatement[x]" }, "comment": "There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated. If there is no abatement element, it is unknown whether the condition has resolved or entered remission; applications and users should generally assume that the condition is still valid. When abatementString exists, it implies the condition is abated.", "condition": [ "con-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Conditions are never really resolved, but they can abate.", "id": "Condition.abatement[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "rim", "map": ".effectiveTime.high or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age at remission\"].value or .inboundRelationship[typeCode=SUBJ]source[classCode=CONC, moodCode=EVN].status=completed" } ], "max": "1", "min": 0, "path": "Condition.abatement[x]", "short": "When in resolution/remission", "type": [ { "code": "dateTime" }, { "code": "Age" }, { "code": "Period" }, { "code": "Range" }, { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.recordedDate" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.", "id": "Condition.recordedDate", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.recorded" }, { "identity": "v2", "map": "REL-11" }, { "identity": "rim", "map": ".participation[typeCode=AUT].time" } ], "max": "1", "min": 1, "path": "Condition.recordedDate", "short": "Date record was first recorded", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.recorder" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Individual who recorded the record and takes responsibility for its content.", "id": "Condition.recorder", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" } ], "max": "1", "min": 1, "path": "Condition.recorder", "short": "Who recorded the condition", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.asserter" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Individual who is making the condition statement.", "id": "Condition.asserter", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.source" }, { "identity": "v2", "map": "REL-7.1 identifier + REL-7.12 type code" }, { "identity": "rim", "map": ".participation[typeCode=INF].role" } ], "max": "0", "min": 0, "path": "Condition.asserter", "short": "Person who asserts this condition", "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" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.stage" }, "constraint": [ { "expression": "summary.exists() or assessment.exists()", "human": "Stage SHALL have summary or assessment", "key": "con-1", "severity": "error", "xpath": "exists(f:summary) or exists(f:assessment)" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Clinical stage or grade of a condition. May include formal severity assessments.", "id": "Condition.stage", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"stage/grade\"]" } ], "max": "0", "min": 0, "path": "Condition.stage", "short": "Stage/grade, usually assessed formally", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.stage.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.stage.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.stage.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.stage.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Condition.stage.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Condition.stage.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.stage.summary" }, "binding": { "description": "Codes describing condition stages (e.g. Cancer stages).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConditionStage" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/condition-stage" }, "condition": [ "con-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A simple summary of the stage such as \"Stage 3\". The determination of the stage is disease-specific.", "id": "Condition.stage.summary", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 254291000 |Staging and scales|" }, { "identity": "v2", "map": "PRB-14" }, { "identity": "rim", "map": ".value" } ], "max": "1", "min": 0, "path": "Condition.stage.summary", "short": "Simple summary (disease specific)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.stage.assessment" }, "condition": [ "con-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Reference to a formal record of the evidence on which the staging assessment is based.", "id": "Condition.stage.assessment", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".self" } ], "max": "*", "min": 0, "path": "Condition.stage.assessment", "short": "Formal record of assessment", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ClinicalImpression", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "http://hl7.org/fhir/StructureDefinition/Observation" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.stage.type" }, "binding": { "description": "Codes describing the kind of condition staging (e.g. clinical or pathological).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConditionStageType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/condition-stage-type" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The kind of staging, such as pathological or clinical staging.", "id": "Condition.stage.type", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"stage type\"]" } ], "max": "1", "min": 0, "path": "Condition.stage.type", "short": "Kind of staging", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.evidence" }, "comment": "The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both.", "constraint": [ { "expression": "code.exists() or detail.exists()", "human": "evidence SHALL have code or details", "key": "con-2", "severity": "error", "xpath": "exists(f:code) or exists(f:detail)" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.", "id": "Condition.evidence", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Condition.evidence", "short": "Supporting evidence", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.evidence.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.evidence.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.evidence.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.evidence.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Condition.evidence.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Condition.evidence.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.evidence.code" }, "binding": { "description": "Codes that describe the manifestation or symptoms of a condition.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ManifestationOrSymptom" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/manifestation-or-symptom" }, "condition": [ "con-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A manifestation or symptom that led to the recording of this condition.", "id": "Condition.evidence.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.reasonCode" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "sct-concept", "map": "< 404684003 |Clinical finding|" }, { "identity": "rim", "map": "[code=\"diagnosis\"].value" } ], "max": "*", "min": 0, "path": "Condition.evidence.code", "short": "Manifestation/symptom", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.evidence.detail" }, "condition": [ "con-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Links to other relevant information, including pathology reports.", "id": "Condition.evidence.detail", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": ".self" } ], "max": "*", "min": 0, "path": "Condition.evidence.detail", "short": "Supporting information found elsewhere", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.note" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.", "id": "Condition.note", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.note" }, { "identity": "v2", "map": "NTE child of PRB" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" } ], "max": "*", "min": 0, "path": "Condition.note", "short": "Additional information about the Condition", "type": [ { "code": "Annotation" } ] } ] }, "status": "draft", "title": "OneHealth Condition Problem List Item", "type": "Condition", "url": "https://fhir.onehealth.com.pe/StructureDefinition/ConditionProblemListItemOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/ConditionEncounterDiagnosisOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Condition", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2023-12-05", "derivation": "constraint", "description": "FHIR Condition Encounter Diagnosis Profile, for OH interoperability scenarios, based on the national CORE Condition Profile defined by HL7 OH.", "differential": { "element": [ { "id": "Condition.identifier.use", "max": "0", "path": "Condition.identifier.use" }, { "id": "Condition.identifier.type", "max": "0", "path": "Condition.identifier.type" }, { "id": "Condition.identifier.system", "min": 1, "path": "Condition.identifier.system" }, { "id": "Condition.identifier.value", "min": 1, "path": "Condition.identifier.value" }, { "id": "Condition.identifier.period", "max": "0", "path": "Condition.identifier.period" }, { "id": "Condition.identifier.assigner", "path": "Condition.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-clinical" }, "id": "Condition.clinicalStatus", "path": "Condition.clinicalStatus" }, { "id": "Condition.clinicalStatus.coding", "max": "1", "min": 1, "path": "Condition.clinicalStatus.coding" }, { "id": "Condition.clinicalStatus.coding.system", "min": 1, "path": "Condition.clinicalStatus.coding.system" }, { "id": "Condition.clinicalStatus.coding.version", "max": "0", "path": "Condition.clinicalStatus.coding.version" }, { "id": "Condition.clinicalStatus.coding.code", "min": 1, "path": "Condition.clinicalStatus.coding.code" }, { "id": "Condition.clinicalStatus.coding.display", "min": 1, "path": "Condition.clinicalStatus.coding.display" }, { "id": "Condition.clinicalStatus.coding.userSelected", "max": "0", "path": "Condition.clinicalStatus.coding.userSelected" }, { "id": "Condition.clinicalStatus.text", "max": "0", "path": "Condition.clinicalStatus.text" }, { "id": "Condition.verificationStatus.coding", "max": "1", "min": 1, "path": "Condition.verificationStatus.coding" }, { "id": "Condition.verificationStatus.coding.system", "min": 1, "path": "Condition.verificationStatus.coding.system" }, { "id": "Condition.verificationStatus.coding.version", "max": "0", "path": "Condition.verificationStatus.coding.version" }, { "id": "Condition.verificationStatus.coding.code", "min": 1, "path": "Condition.verificationStatus.coding.code" }, { "id": "Condition.verificationStatus.coding.display", "min": 1, "path": "Condition.verificationStatus.coding.display" }, { "id": "Condition.verificationStatus.coding.userSelected", "max": "0", "path": "Condition.verificationStatus.coding.userSelected" }, { "id": "Condition.verificationStatus.text", "max": "0", "path": "Condition.verificationStatus.text" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-category" }, "fixedCodeableConcept": { "coding": [ { "code": "encounter-diagnosis", "display": "Encounter Diagnosis", "system": "http://terminology.hl7.org/CodeSystem/condition-category" } ] }, "id": "Condition.category", "max": "1", "min": 1, "path": "Condition.category" }, { "binding": { "description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConditionSeverity" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-severity" }, "id": "Condition.severity", "path": "Condition.severity" }, { "id": "Condition.severity.coding", "max": "1", "min": 1, "path": "Condition.severity.coding" }, { "id": "Condition.severity.coding.system", "min": 1, "path": "Condition.severity.coding.system" }, { "id": "Condition.severity.coding.version", "max": "0", "path": "Condition.severity.coding.version" }, { "id": "Condition.severity.coding.code", "min": 1, "path": "Condition.severity.coding.code" }, { "id": "Condition.severity.coding.display", "min": 1, "path": "Condition.severity.coding.display" }, { "id": "Condition.severity.coding.userSelected", "max": "0", "path": "Condition.severity.coding.userSelected" }, { "id": "Condition.severity.text", "max": "0", "path": "Condition.severity.text" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-code" }, "id": "Condition.code", "min": 1, "path": "Condition.code" }, { "id": "Condition.code.coding", "max": "1", "min": 1, "path": "Condition.code.coding" }, { "id": "Condition.code.coding.system", "min": 1, "path": "Condition.code.coding.system" }, { "id": "Condition.code.coding.version", "max": "0", "path": "Condition.code.coding.version" }, { "id": "Condition.code.coding.code", "min": 1, "path": "Condition.code.coding.code" }, { "id": "Condition.code.coding.display", "min": 1, "path": "Condition.code.coding.display" }, { "id": "Condition.code.coding.userSelected", "max": "0", "path": "Condition.code.coding.userSelected" }, { "id": "Condition.code.text", "max": "0", "path": "Condition.code.text" }, { "id": "Condition.bodySite", "max": "0", "path": "Condition.bodySite" }, { "id": "Condition.subject", "path": "Condition.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Condition.encounter", "path": "Condition.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "id": "Condition.recordedDate", "min": 1, "path": "Condition.recordedDate" }, { "id": "Condition.recorder", "min": 1, "path": "Condition.recorder", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "Condition.asserter", "max": "0", "path": "Condition.asserter" }, { "id": "Condition.stage", "max": "0", "path": "Condition.stage" }, { "id": "Condition.evidence", "max": "0", "path": "Condition.evidence" } ] }, "fhirVersion": "4.0.1", "id": "ConditionEncounterDiagnosisOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "sct-concept", "name": "SNOMED CT Concept Domain Binding", "uri": "http://snomed.info/conceptdomain" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "sct-attr", "name": "SNOMED CT Attribute Binding", "uri": "http://snomed.org/attributebinding" } ], "meta": { "lastUpdated": "2024-04-12T17:46:16.31747+00:00", "versionId": "MTcxMjk0Mzk3NjMxNzQ3MDAwMA" }, "name": "ConditionEncounterDiagnosisOH", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Condition" }, "constraint": [ { "expression": "clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "Most systems will expect a clinicalStatus to be valued for problem-list-items that are managed over time, but might not need a clinicalStatus for point in time encounter-diagnosis." } ], "human": "Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item", "key": "con-3", "severity": "warning", "xpath": "exists(f:clinicalStatus) or exists(f:verificationStatus/f:coding/f:code/@value='entered-in-error') or not(exists(category[@value='problem-list-item']))" }, { "expression": "abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()", "human": "If condition is abated, then clinicalStatus must be either inactive, resolved, or remission", "key": "con-4", "severity": "error", "xpath": "not(exists(*[starts-with(local-name(.), 'abatement')])) or exists(f:clinicalStatus/f:coding[f:system/@value='http://terminology.hl7.org/CodeSystem/condition-clinical' and f:code/@value=('resolved', 'remission', 'inactive')])" }, { "expression": "verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()", "human": "Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error", "key": "con-5", "severity": "error", "xpath": "not(exists(f:verificationStatus/f:coding[f:system/@value='http://terminology.hl7.org/CodeSystem/condition-ver-status' and f:code/@value='entered-in-error'])) or not(exists(f:clinicalStatus))" }, { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.", "id": "Condition", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "sct-concept", "map": "< 243796009 |Situation with explicit context| : 246090004 |Associated finding| = ( ( < 404684003 |Clinical finding| MINUS ( << 420134006 |Propensity to adverse reactions| OR << 473010000 |Hypersensitivity condition| OR << 79899007 |Drug interaction| OR << 69449002 |Drug action| OR << 441742003 |Evaluation finding| OR << 307824009 |Administrative status| OR << 385356007 |Tumor stage finding|)) OR < 272379006 |Event|)" }, { "identity": "v2", "map": "PPR message" }, { "identity": "rim", "map": "Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value<Diagnosis]" } ], "max": "*", "min": 0, "path": "Condition", "short": "Detailed information about conditions, problems or diagnoses" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Condition.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Condition.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Condition.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Condition.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Condition.implicitRules", "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, "max": "1", "min": 0, "path": "Condition.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Condition.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Condition.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Condition.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Condition.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Condition.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Condition.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Condition.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Condition.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Condition.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.identifier" }, "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 a Person resource instance might share the same social insurance number.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", "id": "Condition.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": ".id" } ], "max": "*", "min": 0, "path": "Condition.identifier", "requirements": "Allows identification of the condition as it is known by various participating systems and in a way that remains consistent across servers.", "short": "External Ids for this condition", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "id": "Condition.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "Condition.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "Condition.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "Condition.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "id": "Condition.identifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 1, "path": "Condition.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "example": [ { "label": "General", "valueString": "123456" } ], "id": "Condition.identifier.value", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "Condition.identifier.value", "short": "The value that is unique", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "Condition.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "0", "min": 0, "path": "Condition.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "Condition.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 0, "path": "Condition.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.clinicalStatus" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-clinical" }, "comment": "The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.", "condition": [ "con-3", "con-4", "con-5" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The clinical status of the condition.", "id": "Condition.clinicalStatus", "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the status contains codes that mark the condition as no longer active.", "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "sct-concept", "map": "< 303105007 |Disease phases|" }, { "identity": "v2", "map": "PRB-14" }, { "identity": "rim", "map": "Observation ACT\n.inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"clinicalStatus\", moodCode=EVN].value" } ], "max": "1", "min": 0, "path": "Condition.clinicalStatus", "short": "active | recurrence | relapse | inactive | remission | resolved", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.clinicalStatus.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.clinicalStatus.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.clinicalStatus.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.clinicalStatus.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Condition.clinicalStatus.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Condition.clinicalStatus.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.clinicalStatus.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.clinicalStatus.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.clinicalStatus.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.clinicalStatus.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Condition.clinicalStatus.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Condition.clinicalStatus.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Condition.clinicalStatus.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Condition.clinicalStatus.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Condition.clinicalStatus.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Condition.clinicalStatus.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.clinicalStatus.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Condition.clinicalStatus.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Condition.clinicalStatus.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Condition.clinicalStatus.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.clinicalStatus.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Condition.clinicalStatus.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.verificationStatus" }, "binding": { "description": "The verification status to support or decline the clinical status of the condition or diagnosis.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConditionVerificationStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1" }, "comment": "verificationStatus is not required. For example, when a patient has abdominal pain in the ED, there is not likely going to be a verification status.\nThe data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.", "condition": [ "con-3", "con-5" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The verification status to support the clinical status of the condition.", "id": "Condition.verificationStatus", "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the status contains the code refuted and entered-in-error that mark the Condition as not currently valid.", "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "sct-concept", "map": "< 410514004 |Finding context value|" }, { "identity": "v2", "map": "PRB-13" }, { "identity": "rim", "map": "Observation ACT\n.inboundRelationship[typeCode=COMP].source[classCode=OBS, code=\"verificationStatus\", moodCode=EVN].value" }, { "identity": "sct-attr", "map": "408729009" } ], "max": "1", "min": 0, "path": "Condition.verificationStatus", "short": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.verificationStatus.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.verificationStatus.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.verificationStatus.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.verificationStatus.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Condition.verificationStatus.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Condition.verificationStatus.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.verificationStatus.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.verificationStatus.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.verificationStatus.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.verificationStatus.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Condition.verificationStatus.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Condition.verificationStatus.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Condition.verificationStatus.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Condition.verificationStatus.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Condition.verificationStatus.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Condition.verificationStatus.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.verificationStatus.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Condition.verificationStatus.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Condition.verificationStatus.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Condition.verificationStatus.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.verificationStatus.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Condition.verificationStatus.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.category" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-category" }, "comment": "The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A category assigned to the condition.", "fixedCodeableConcept": { "coding": [ { "code": "encounter-diagnosis", "display": "Encounter Diagnosis", "system": "http://terminology.hl7.org/CodeSystem/condition-category" } ] }, "id": "Condition.category", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "sct-concept", "map": "< 404684003 |Clinical finding|" }, { "identity": "v2", "map": "'problem' if from PRB-3. 'diagnosis' if from DG1 segment in PV1 message" }, { "identity": "rim", "map": ".code" } ], "max": "1", "min": 1, "path": "Condition.category", "short": "problem-list-item | encounter-diagnosis", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.severity" }, "binding": { "description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConditionSeverity" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-severity" }, "comment": "Coding of the severity with a terminology is preferred, where possible.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A subjective assessment of the severity of the condition as evaluated by the clinician.", "id": "Condition.severity", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.grade" }, { "identity": "sct-concept", "map": "< 272141005 |Severities|" }, { "identity": "v2", "map": "PRB-26 / ABS-3" }, { "identity": "rim", "map": "Can be pre/post-coordinated into value. Or ./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"severity\"].value" }, { "identity": "sct-attr", "map": "246112005" } ], "max": "1", "min": 0, "path": "Condition.severity", "short": "Subjective severity of condition", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.severity.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.severity.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.severity.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.severity.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Condition.severity.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Condition.severity.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.severity.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.severity.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.severity.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.severity.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Condition.severity.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Condition.severity.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Condition.severity.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Condition.severity.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Condition.severity.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Condition.severity.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.severity.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Condition.severity.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Condition.severity.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Condition.severity.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.severity.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Condition.severity.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "type" ], "base": { "max": "1", "min": 0, "path": "Condition.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/condition-code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identification of the condition, problem or diagnosis.", "id": "Condition.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "sct-concept", "map": "code 246090004 |Associated finding| (< 404684003 |Clinical finding| MINUS\n<< 420134006 |Propensity to adverse reactions| MINUS \n<< 473010000 |Hypersensitivity condition| MINUS \n<< 79899007 |Drug interaction| MINUS\n<< 69449002 |Drug action| MINUS \n<< 441742003 |Evaluation finding| MINUS \n<< 307824009 |Administrative status| MINUS \n<< 385356007 |Tumor stage finding|) \nOR < 413350009 |Finding with explicit context|\nOR < 272379006 |Event|" }, { "identity": "v2", "map": "PRB-3" }, { "identity": "rim", "map": ".value" }, { "identity": "sct-attr", "map": "246090004" } ], "max": "1", "min": 1, "path": "Condition.code", "requirements": "0..1 to account for primarily narrative only resources.", "short": "Identification of the condition, problem or diagnosis", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "Condition.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "1", "min": 1, "path": "Condition.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "Condition.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "Condition.code.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "Condition.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "Condition.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "Condition.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "Condition.code.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "Condition.code.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "Condition.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "Condition.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "Condition.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "Condition.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.bodySite" }, "binding": { "description": "Codes describing anatomical locations. May include laterality.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BodySite" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/body-site" }, "comment": "Only used if not implicit in code found in Condition.code. 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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The anatomical location where this condition manifests itself.", "id": "Condition.bodySite", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "sct-concept", "map": "< 442083009 |Anatomical or acquired body structure|" }, { "identity": "rim", "map": ".targetBodySiteCode" }, { "identity": "sct-attr", "map": "363698007" } ], "max": "0", "min": 0, "path": "Condition.bodySite", "short": "Anatomical location, if relevant", "type": [ { "code": "CodeableConcept" } ] }, { "alias": [ "patient" ], "base": { "max": "1", "min": 1, "path": "Condition.subject" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the patient or group who the condition record is associated with.", "id": "Condition.subject", "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[classCode=PAT]" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 1, "path": "Condition.subject", "requirements": "Group is typically used for veterinary or public health use cases.", "short": "Who has the condition?", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.encounter" }, "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. This record indicates the encounter this particular record is associated with. In the case of a \"new\" diagnosis reflecting ongoing/revised information about the condition, this might be distinct from the first encounter in which the underlying condition was first \"known\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Encounter during which this Condition was created or to which the creation of this record is tightly associated.", "id": "Condition.encounter", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.context" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "v2", "map": "PV1-19 (+PV1-54)" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]" } ], "max": "1", "min": 0, "path": "Condition.encounter", "short": "Encounter created as part of", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.onset[x]" }, "comment": "Age is generally used when the patient reports an age at which the Condition began to occur.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Estimated or actual date or date-time the condition began, in the opinion of the clinician.", "id": "Condition.onset[x]", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.init" }, { "identity": "v2", "map": "PRB-16" }, { "identity": "rim", "map": ".effectiveTime.low or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age at onset\"].value" } ], "max": "1", "min": 0, "path": "Condition.onset[x]", "short": "Estimated or actual date, date-time, or age", "type": [ { "code": "dateTime" }, { "code": "Age" }, { "code": "Period" }, { "code": "Range" }, { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.abatement[x]" }, "comment": "There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated. If there is no abatement element, it is unknown whether the condition has resolved or entered remission; applications and users should generally assume that the condition is still valid. When abatementString exists, it implies the condition is abated.", "condition": [ "con-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Conditions are never really resolved, but they can abate.", "id": "Condition.abatement[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "rim", "map": ".effectiveTime.high or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age at remission\"].value or .inboundRelationship[typeCode=SUBJ]source[classCode=CONC, moodCode=EVN].status=completed" } ], "max": "1", "min": 0, "path": "Condition.abatement[x]", "short": "When in resolution/remission", "type": [ { "code": "dateTime" }, { "code": "Age" }, { "code": "Period" }, { "code": "Range" }, { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.recordedDate" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.", "id": "Condition.recordedDate", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.recorded" }, { "identity": "v2", "map": "REL-11" }, { "identity": "rim", "map": ".participation[typeCode=AUT].time" } ], "max": "1", "min": 1, "path": "Condition.recordedDate", "short": "Date record was first recorded", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.recorder" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Individual who recorded the record and takes responsibility for its content.", "id": "Condition.recorder", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" } ], "max": "1", "min": 1, "path": "Condition.recorder", "short": "Who recorded the condition", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.asserter" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Individual who is making the condition statement.", "id": "Condition.asserter", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.source" }, { "identity": "v2", "map": "REL-7.1 identifier + REL-7.12 type code" }, { "identity": "rim", "map": ".participation[typeCode=INF].role" } ], "max": "0", "min": 0, "path": "Condition.asserter", "short": "Person who asserts this condition", "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" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.stage" }, "constraint": [ { "expression": "summary.exists() or assessment.exists()", "human": "Stage SHALL have summary or assessment", "key": "con-1", "severity": "error", "xpath": "exists(f:summary) or exists(f:assessment)" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Clinical stage or grade of a condition. May include formal severity assessments.", "id": "Condition.stage", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"stage/grade\"]" } ], "max": "0", "min": 0, "path": "Condition.stage", "short": "Stage/grade, usually assessed formally", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.stage.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.stage.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.stage.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.stage.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Condition.stage.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Condition.stage.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.stage.summary" }, "binding": { "description": "Codes describing condition stages (e.g. Cancer stages).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConditionStage" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/condition-stage" }, "condition": [ "con-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A simple summary of the stage such as \"Stage 3\". The determination of the stage is disease-specific.", "id": "Condition.stage.summary", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "sct-concept", "map": "< 254291000 |Staging and scales|" }, { "identity": "v2", "map": "PRB-14" }, { "identity": "rim", "map": ".value" } ], "max": "1", "min": 0, "path": "Condition.stage.summary", "short": "Simple summary (disease specific)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.stage.assessment" }, "condition": [ "con-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Reference to a formal record of the evidence on which the staging assessment is based.", "id": "Condition.stage.assessment", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".self" } ], "max": "*", "min": 0, "path": "Condition.stage.assessment", "short": "Formal record of assessment", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ClinicalImpression", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "http://hl7.org/fhir/StructureDefinition/Observation" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Condition.stage.type" }, "binding": { "description": "Codes describing the kind of condition staging (e.g. clinical or pathological).", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ConditionStageType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/condition-stage-type" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The kind of staging, such as pathological or clinical staging.", "id": "Condition.stage.type", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"stage type\"]" } ], "max": "1", "min": 0, "path": "Condition.stage.type", "short": "Kind of staging", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.evidence" }, "comment": "The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both.", "constraint": [ { "expression": "code.exists() or detail.exists()", "human": "evidence SHALL have code or details", "key": "con-2", "severity": "error", "xpath": "exists(f:code) or exists(f:detail)" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.", "id": "Condition.evidence", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN]" } ], "max": "0", "min": 0, "path": "Condition.evidence", "short": "Supporting evidence", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Condition.evidence.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Condition.evidence.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Condition.evidence.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Condition.evidence.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Condition.evidence.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Condition.evidence.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.evidence.code" }, "binding": { "description": "Codes that describe the manifestation or symptoms of a condition.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ManifestationOrSymptom" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/manifestation-or-symptom" }, "condition": [ "con-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A manifestation or symptom that led to the recording of this condition.", "id": "Condition.evidence.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.reasonCode" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "sct-concept", "map": "< 404684003 |Clinical finding|" }, { "identity": "rim", "map": "[code=\"diagnosis\"].value" } ], "max": "*", "min": 0, "path": "Condition.evidence.code", "short": "Manifestation/symptom", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.evidence.detail" }, "condition": [ "con-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Links to other relevant information, including pathology reports.", "id": "Condition.evidence.detail", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": ".self" } ], "max": "*", "min": 0, "path": "Condition.evidence.detail", "short": "Supporting information found elsewhere", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Condition.note" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.", "id": "Condition.note", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Event.note" }, { "identity": "v2", "map": "NTE child of PRB" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" } ], "max": "*", "min": 0, "path": "Condition.note", "short": "Additional information about the Condition", "type": [ { "code": "Annotation" } ] } ] }, "status": "draft", "title": "OneHealth Condition Encounter Diagnosis", "type": "Condition", "url": "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/CompositionRecommendationOfRestOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Composition", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-15", "derivation": "constraint", "description": "FHIR CompositionRecommendationOfRestOH Profile, for OH interoperability scenarios, based on the national CORE Composition Profile defined by HL7 OH.", "differential": { "element": [ { "definition": "Informar el sistema del cual proviene la información (Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)", "id": "Composition.meta.source", "min": 1, "path": "Composition.meta.source", "short": "Informar el sistema del cual proviene la información (Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)" }, { "id": "Composition.identifier", "max": "0", "path": "Composition.identifier" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-typecodes" }, "definition": "Specifies that this composition refers to a Physician Outpatient Note (Loinc \"83798-9\")\r\n", "id": "Composition.type", "path": "Composition.type", "patternCodeableConcept": { "coding": [ { "code": "83798-9", "system": "http://loinc.org" } ] }, "short": "Kind of composition (\"Physician Outpatient Note\")" }, { "id": "Composition.category", "max": "0", "path": "Composition.category" }, { "id": "Composition.subject", "min": 1, "path": "Composition.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Composition.encounter", "min": 1, "path": "Composition.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "id": "Composition.author", "path": "Composition.author", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "Composition.attester", "max": "0", "path": "Composition.attester" }, { "id": "Composition.custodian", "path": "Composition.custodian", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Composition.relatesTo", "max": "1", "path": "Composition.relatesTo" }, { "fixedCode": "appends", "id": "Composition.relatesTo.code", "path": "Composition.relatesTo.code" }, { "id": "Composition.relatesTo.target[x]", "path": "Composition.relatesTo.target[x]", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/CompositionOutpatientProgressNoteOH" ] } ] }, { "id": "Composition.event", "max": "0", "path": "Composition.event" }, { "definition": "This document contains additional documentation captured by the provider related to care provided or planned for the patient that is not supported in any other section of the document.", "id": "Composition.section", "path": "Composition.section", "short": "OH History of Pregnancy Section" }, { "id": "Composition.section.title", "min": 1, "path": "Composition.section.title", "patternString": "Documentación Adicional" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-section-codes" }, "id": "Composition.section.code", "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "83798-9", "system": "http://loinc.org" } ] } }, { "id": "Composition.section.author", "path": "Composition.section.author", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "Composition.section.text", "min": 1, "path": "Composition.section.text" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-order" }, "id": "Composition.section.orderedBy", "path": "Composition.section.orderedBy" }, { "id": "Composition.section.entry", "min": 1, "path": "Composition.section.entry", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsRecommendationToRestOH" ] } ] }, { "id": "Composition.section.emptyReason", "max": "0", "path": "Composition.section.emptyReason" }, { "id": "Composition.section.section", "max": "0", "path": "Composition.section.section" } ] }, "fhirVersion": "4.0.1", "id": "CompositionRecommendationOfRestOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "cda", "name": "CDA (R2)", "uri": "http://hl7.org/v3/cda" }, { "identity": "fhirdocumentreference", "name": "FHIR DocumentReference", "uri": "http://hl7.org/fhir/documentreference" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" } ], "meta": { "lastUpdated": "2024-04-12T17:46:16.028647+00:00", "versionId": "MTcxMjk0Mzk3NjAyODY0NzAwMA" }, "name": "CompositionRecommendationOfRestOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Composition" }, "comment": "While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).", "id": "Composition", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "rim", "map": "Document[classCode=\"DOC\" and moodCode=\"EVN\" and isNormalAct()]" }, { "identity": "cda", "map": "ClinicalDocument" }, { "identity": "fhirdocumentreference", "map": "when described by DocumentReference" } ], "max": "*", "min": 0, "path": "Composition", "short": "A set of resources composed into a single coherent clinical statement with clinical attestation" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Composition.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Composition.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Composition.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Composition.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.meta.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.meta.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.meta.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.meta.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Meta.versionId" }, "comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.", "id": "Composition.meta.versionId", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Composition.meta.versionId", "short": "Version specific identifier", "type": [ { "code": "id" } ] }, { "base": { "max": "1", "min": 0, "path": "Meta.lastUpdated" }, "comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http.html#read) interaction.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When the resource last changed - e.g. when the version changed.", "id": "Composition.meta.lastUpdated", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Composition.meta.lastUpdated", "short": "When the resource version last changed", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Meta.source" }, "comment": "In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. \n\nThis element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Informar el sistema del cual proviene la información (Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)", "id": "Composition.meta.source", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Composition.meta.source", "short": "Informar el sistema del cual proviene la información (Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)", "type": [ { "code": "uri" } ] }, { "base": { "max": "*", "min": 0, "path": "Meta.profile" }, "comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).", "id": "Composition.meta.profile", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "path": "Composition.meta.profile", "short": "Profiles this resource claims to conform to", "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Meta.security" }, "binding": { "description": "Security Labels from the Healthcare Privacy and Security Classification System.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SecurityLabels" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/security-labels" }, "comment": "The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.", "id": "Composition.meta.security", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "path": "Composition.meta.security", "short": "Security Labels applied to this resource", "type": [ { "code": "Coding" } ] }, { "base": { "max": "*", "min": 0, "path": "Meta.tag" }, "binding": { "description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\".", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Tags" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/common-tags" }, "comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.", "id": "Composition.meta.tag", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "path": "Composition.meta.tag", "short": "Tags applied to this resource", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Composition.implicitRules", "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, "max": "1", "min": 0, "path": "Composition.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Composition.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Composition.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Composition.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Composition.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Composition.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Composition.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Composition.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.identifier" }, "comment": "Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.", "id": "Composition.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": "Document.id / Document.setId" }, { "identity": "cda", "map": ".setId" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.masterIdentifier" } ], "max": "0", "min": 0, "path": "Composition.identifier", "short": "Version-independent identifier for the Composition", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 1, "path": "Composition.status" }, "binding": { "description": "The workflow/clinical status of the composition.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CompositionStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/composition-status|4.0.1" }, "comment": "If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag \"entered-in-error\" is why this element is labeled as a modifier of other elements. \n\nSome reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.", "id": "Composition.status", "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, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\"; final: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseComposition\", code) and isNormalAct()]); amended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseComposition\", code) and isNormalAct() and statusCode=\"completed\"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\"" }, { "identity": "cda", "map": "n/a" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.status" } ], "max": "1", "min": 1, "path": "Composition.status", "requirements": "Need to be able to mark interim, amended, or withdrawn compositions or documents.", "short": "preliminary | final | amended | entered-in-error", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Composition.type" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-typecodes" }, "comment": "For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies that this composition refers to a Physician Outpatient Note (Loinc \"83798-9\")\r\n", "id": "Composition.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": "./code" }, { "identity": "cda", "map": ".code" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.type" } ], "max": "1", "min": 1, "path": "Composition.type", "patternCodeableConcept": { "coding": [ { "code": "83798-9", "system": "http://loinc.org" } ] }, "requirements": "Key metadata element describing the composition, used in searching/filtering.", "short": "Kind of composition (\"Physician Outpatient Note\")", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.category" }, "binding": { "description": "High-level kind of a clinical document at a macro level.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentCategory" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/document-classcodes" }, "comment": "This is a metadata field from [XDS/MHD](http://wiki.ihe.net/index.php?title=Mobile_access_to_Health_Documents_(MHD)).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.", "id": "Composition.category", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" }, { "identity": "cda", "map": "n/a" }, { "identity": "fhirdocumentreference", "map": "DocumenttReference.category" } ], "max": "0", "min": 0, "path": "Composition.category", "requirements": "Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents.", "short": "Categorization of Composition", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.subject" }, "comment": "For clinical documents, this is usually the patient.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).", "id": "Composition.subject", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "rim", "map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]" }, { "identity": "cda", "map": ".recordTarget" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.subject" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 1, "path": "Composition.subject", "requirements": "Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.", "short": "Who and/or what the composition is about", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.encounter" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes the clinical encounter or type of care this documentation is associated with.", "id": "Composition.encounter", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.context" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "rim", "map": "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])" }, { "identity": "cda", "map": ".componentOf.encompassingEncounter" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.context.encounter" } ], "max": "1", "min": 1, "path": "Composition.encounter", "requirements": "Provides context for the composition and supports searching.", "short": "Context of the Composition", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Composition.date" }, "comment": "The Last Modified Date on the composition may be after the date of the document was attested without being changed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The composition editing time, when the composition was last logically changed by the author.", "id": "Composition.date", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "rim", "map": ".effectiveTime[type=\"TS\"]" }, { "identity": "cda", "map": ".effectiveTime" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.content.attachment.date, DocumentReference.created" } ], "max": "1", "min": 1, "path": "Composition.date", "requirements": "dateTime is used for tracking, organizing versions and searching. Note that this is the time of *authoring*. When packaged in a document, [Bundle.timestamp](bundle-definitions.html#Bundle.timestamp) is the date of packaging.", "short": "Composition editing time", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "*", "min": 1, "path": "Composition.author" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies who is responsible for the information in the composition, not necessarily who typed it in.", "id": "Composition.author", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer" }, { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "cda", "map": ".author.assignedAuthor" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.agent" } ], "max": "*", "min": 1, "path": "Composition.author", "requirements": "Identifies who is responsible for the content.", "short": "Who and/or what authored the composition", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Composition.title" }, "comment": "For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a \"consultation\" or \"progress note\"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Official human-readable label for the composition.", "id": "Composition.title", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "./title" }, { "identity": "cda", "map": ".title" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.description, DocumentReference.content.attachment.title" } ], "max": "1", "min": 1, "path": "Composition.title", "short": "Human Readable name/title", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.confidentiality" }, "binding": { "description": "Codes specifying the level of confidentiality of the composition.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentConfidentiality" } ], "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26" }, "comment": "The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The code specifying the level of confidentiality of the Composition.", "id": "Composition.confidentiality", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".confidentialityCode" }, { "identity": "cda", "map": ".confidentialityCode" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.securityLabel" } ], "max": "1", "min": 0, "path": "Composition.confidentiality", "short": "As defined by affinity domain", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.attester" }, "comment": "Only list each attester once.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A participant who has attested to the accuracy of the composition/document.", "id": "Composition.attester", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "cda", "map": ".authenticator/.legalAuthenticator" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.authenticator" } ], "max": "0", "min": 0, "path": "Composition.attester", "requirements": "Identifies responsibility for the accuracy of the composition content.", "short": "Attests to accuracy of composition", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.attester.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.attester.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.attester.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.attester.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.attester.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.attester.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Composition.attester.mode" }, "binding": { "description": "The way in which a person authenticated a composition.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CompositionAttestationMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The type of attestation the authenticator offers.", "id": "Composition.attester.mode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "unique(./modeCode)" }, { "identity": "cda", "map": "implied by .authenticator/.legalAuthenticator" } ], "max": "1", "min": 1, "path": "Composition.attester.mode", "requirements": "Indicates the level of authority of the attestation.", "short": "personal | professional | legal | official", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.attester.time" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When the composition was attested by the party.", "id": "Composition.attester.time", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./time[type=\"TS\" and isNormalDatatype()]" }, { "identity": "cda", "map": ".authenticator.time" } ], "max": "1", "min": 0, "path": "Composition.attester.time", "requirements": "Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).", "short": "When the composition was attested", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.attester.party" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who attested the composition in the specified way.", "id": "Composition.attester.party", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.witness" }, { "identity": "rim", "map": "./role[classCode=\"ASSIGNED\" and isNormalRole]/player[determinerCode=\"INST\" and classCode=(\"DEV\", \"PSN\") and isNormalEntity()] or ./role[classCode=\"ASSIGNED\" and isNormalRole and not(player)]/scoper[determinerCode=\"INST\" and classCode=\"ORG\" and isNormalEntity()]" }, { "identity": "cda", "map": ".authenticator.assignedEnttty" } ], "max": "1", "min": 0, "path": "Composition.attester.party", "requirements": "Identifies who has taken on the responsibility for accuracy of the composition content.", "short": "Who attested the composition", "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", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.custodian" }, "comment": "This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.", "id": "Composition.custodian", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]" }, { "identity": "cda", "map": ".custodian.assignedCustodian" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.custodian" } ], "max": "1", "min": 0, "path": "Composition.custodian", "requirements": "Identifies where to go to find the current version, where to report issues, etc.", "short": "Organization which maintains the composition", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.relatesTo" }, "comment": "A document is a version specific composition.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Relationships that this composition has with other compositions or documents that already exist.", "id": "Composition.relatesTo", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship" }, { "identity": "cda", "map": ".relatedDocument" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.relatesTo" } ], "max": "1", "min": 0, "path": "Composition.relatesTo", "short": "Relationships to other compositions/documents", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.relatesTo.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.relatesTo.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.relatesTo.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.relatesTo.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.relatesTo.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.relatesTo.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Composition.relatesTo.code" }, "binding": { "description": "The type of relationship between documents.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentRelationshipType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1" }, "comment": "If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The type of relationship that this composition has with anther composition or document.", "fixedCode": "appends", "id": "Composition.relatesTo.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship.typeCode" }, { "identity": "cda", "map": ".relatedDocument.typeCode" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.relatesTo.code" } ], "max": "1", "min": 1, "path": "Composition.relatesTo.code", "short": "replaces | transforms | signs | appends", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Composition.relatesTo.target[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The target composition/document of this relationship.", "id": "Composition.relatesTo.target[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id" }, { "identity": "cda", "map": ".relatedDocument.id" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.relatesTo.target" } ], "max": "1", "min": 1, "path": "Composition.relatesTo.target[x]", "short": "Target of the relationship", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/CompositionOutpatientProgressNoteOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.event" }, "comment": "The event needs to be consistent with the type element, though can provide further information if desired.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The clinical service, such as a colonoscopy or an appendectomy, being documented.", "id": "Composition.event", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']" }, { "identity": "cda", "map": ".documentationOf.serviceEvent" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.event" } ], "max": "0", "min": 0, "path": "Composition.event", "requirements": "Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.", "short": "The clinical service(s) being documented", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.event.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.event.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.event.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.event.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.event.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.event.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.event.code" }, "binding": { "description": "This list of codes represents the main clinical acts being documented.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentEventType" } ], "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActCode" }, "comment": "An event can further specialize the act inherent in the typeCode, such as where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.", "id": "Composition.event.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".code" }, { "identity": "cda", "map": ".code" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.event.code" } ], "max": "*", "min": 0, "path": "Composition.event.code", "short": "Code(s) that apply to the event being documented", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.event.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.", "id": "Composition.event.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".effectiveTime" }, { "identity": "cda", "map": ".effectiveTime" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.event.period" } ], "max": "1", "min": 0, "path": "Composition.event.period", "short": "The period covered by the documentation", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.event.detail" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.", "id": "Composition.event.detail", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=\"SUBJ\"].target" }, { "identity": "cda", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.event.detail", "short": "The event(s) being documented", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section" }, "constraint": [ { "expression": "text.exists() or entry.exists() or section.exists()", "human": "A section must contain at least one of text, entries, or sub-sections", "key": "cmp-1", "severity": "error", "xpath": "exists(f:text) or exists(f:entry) or exists(f:section)" }, { "expression": "emptyReason.empty() or entry.empty()", "human": "A section can only have an emptyReason if it is empty", "key": "cmp-2", "severity": "error", "xpath": "not(exists(f:emptyReason) and exists(f:entry))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This document contains additional documentation captured by the provider related to care provided or planned for the patient that is not supported in any other section of the document.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Section" } ], "id": "Composition.section", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.structuredBody.component.section" } ], "max": "*", "min": 0, "path": "Composition.section", "short": "OH History of Pregnancy Section", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.section.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.section.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.section.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.section.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.section.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "alias": [ "header", "label", "caption" ], "base": { "max": "1", "min": 0, "path": "Composition.section.title" }, "comment": "The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.", "id": "Composition.section.title", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./title" }, { "identity": "cda", "map": ".title" } ], "max": "1", "min": 1, "path": "Composition.section.title", "patternString": "Documentación Adicional", "requirements": "Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.", "short": "Label for section (e.g. for ToC)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-section-codes" }, "comment": "The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. \n\nIf the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code identifying the kind of content contained within the section. This must be consistent with the section title.", "id": "Composition.section.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./code" }, { "identity": "cda", "map": ".code" } ], "max": "1", "min": 0, "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "83798-9", "system": "http://loinc.org" } ] }, "requirements": "Provides computable standardized labels to topics within the document.", "short": "Classification of section (recommended)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.author" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies who is responsible for the information in this section, not necessarily who typed it in.", "id": "Composition.section.author", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "cda", "map": ".author.assignedAuthor" } ], "max": "*", "min": 0, "path": "Composition.section.author", "requirements": "Identifies who is responsible for the content.", "short": "Who and/or what authored the section", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.focus" }, "comment": "Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).", "id": "Composition.section.focus", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "cda", "map": ".subject? (CDA did not differentiate between subject and focus)" } ], "max": "1", "min": 0, "path": "Composition.section.focus", "short": "Who/what the section is about, when it is not about the subject of composition", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.text" }, "comment": "Document profiles may define what content should be represented in the narrative to ensure clinical safety.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative.", "id": "Composition.section.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".text" }, { "identity": "cda", "map": ".text" } ], "max": "1", "min": 1, "path": "Composition.section.text", "short": "Text summary of the section, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.mode" }, "binding": { "description": "The processing mode that applies to this section.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-mode|4.0.1" }, "comment": "This element is labeled as a modifier because a change list must not be misunderstood as a complete list.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.", "id": "Composition.section.mode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.mode", "requirements": "Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.", "short": "working | snapshot | changes", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.orderedBy" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-order" }, "comment": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the order applied to the items in the section entries.", "id": "Composition.section.orderedBy", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.orderedBy", "requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.", "short": "Order of section entries", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.entry" }, "comment": "If there are no entries in the list, an emptyReason SHOULD be provided.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to the actual resource from which the narrative in the section is derived.", "id": "Composition.section.entry", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" }, { "identity": "cda", "map": ".entry" } ], "max": "*", "min": 1, "path": "Composition.section.entry", "short": "A reference to data that supports this section", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsRecommendationToRestOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.emptyReason" }, "binding": { "description": "If a section is empty, why it is empty.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionEmptyReason" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/list-empty-reason" }, "comment": "The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.", "id": "Composition.section.emptyReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]" }, { "identity": "cda", "map": "n/a" } ], "max": "0", "min": 0, "path": "Composition.section.emptyReason", "requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.", "short": "Why the section is empty", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.section" }, "comment": "Nested sections are primarily used to help human readers navigate to particular portions of the document.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Composition.section", "definition": "A nested sub-section within this section.", "id": "Composition.section.section", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.section" } ], "max": "0", "min": 0, "path": "Composition.section.section", "short": "Nested Section" } ] }, "status": "draft", "title": "OneHealth CompositionRecommendationOfRest", "type": "Composition", "url": "https://fhir.onehealth.com.pe/StructureDefinition/CompositionRecommendationOfRestOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/CompositionOutpatientProgressNoteOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Composition", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-15", "derivation": "constraint", "description": "FHIR CompositionOutpatientProgressNoteOH Profile, for OH interoperability scenarios, based on the national CORE Composition Profile defined by HL7 OH.", "differential": { "element": [ { "definition": "Informar el sistema del cual proviene la información (Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)", "id": "Composition.meta.source", "min": 1, "path": "Composition.meta.source", "short": "Informar el sistema del cual proviene la información (Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)" }, { "id": "Composition.identifier", "max": "0", "path": "Composition.identifier" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-typecodes" }, "definition": "Specifies that this composition refers to a Attending Outpatient Progress note (Loinc \"100441-5\")\r\n", "id": "Composition.type", "path": "Composition.type", "patternCodeableConcept": { "coding": [ { "code": "100441-5", "system": "http://loinc.org" } ] }, "short": "Kind of composition (\"Attending Outpatient Progress note\")" }, { "id": "Composition.category", "max": "0", "path": "Composition.category" }, { "id": "Composition.subject", "min": 1, "path": "Composition.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Composition.encounter", "min": 1, "path": "Composition.encounter", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "id": "Composition.author", "path": "Composition.author", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "Composition.attester", "max": "0", "path": "Composition.attester" }, { "id": "Composition.custodian", "path": "Composition.custodian", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Composition.relatesTo", "max": "0", "path": "Composition.relatesTo" }, { "id": "Composition.event", "max": "0", "path": "Composition.event" }, { "definition": "The root of the sections that make up the Attending Outpatient Progress note Composition.", "id": "Composition.section", "path": "Composition.section", "short": "Sections composing the Attending Outpatient Progress note Composition", "slicing": { "discriminator": [ { "path": "code", "type": "pattern" } ], "ordered": false, "rules": "open" } }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-section-codes" }, "id": "Composition.section.code", "min": 1, "path": "Composition.section.code" }, { "id": "Composition.section.text", "min": 1, "path": "Composition.section.text" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-order" }, "id": "Composition.section.orderedBy", "path": "Composition.section.orderedBy" }, { "id": "Composition.section.emptyReason", "max": "0", "mustSupport": false, "path": "Composition.section.emptyReason" }, { "id": "Composition.section.section", "max": "0", "mustSupport": false, "path": "Composition.section.section" }, { "definition": "The section includes direct observations made by a clinician. The examination may include the use of simple instruments and may also describe simple maneuvers performed directly on the patients body. It also includes observations made by the examining clinician using only inspection, palpation, auscultation, and percussion. It does not include laboratory or imaging findings. The exam may be limited to pertinent body systems based on the patients chief complaint or it may include a comprehensive examination. The examination may be reported as a collection of random clinical statements or it may be reported categorically. ", "id": "Composition.section:sectionPhysicalExam", "max": "1", "min": 0, "path": "Composition.section", "short": "OH Physical Exam Section", "sliceName": "sectionPhysicalExam" }, { "id": "Composition.section:sectionPhysicalExam.title", "min": 1, "path": "Composition.section.title", "patternString": "Exámen físico" }, { "id": "Composition.section:sectionPhysicalExam.code", "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "29545-1", "system": "http://loinc.org" } ] } }, { "id": "Composition.section:sectionPhysicalExam.entry", "min": 1, "path": "Composition.section.entry", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBodyHeightOH", "https://fhir.onehealth.com.pe/StructureDefinition/ObsBodyWeightOH", "https://fhir.onehealth.com.pe/StructureDefinition/ObsBMIOH" ] } ] }, { "definition": "The medication summary section contains a description of the patient's medications relevant for the scope of the patient summary.\r\nThe actual content could depend on the jurisdiction, it could report:\r\n- the currently active medications; \r\n- the current and past medications considered relevant by the authoring GP; \r\n- the patient prescriptions or dispensations automatically extracted by a EAPB, regional or a national EHR.\r\n\r\nIn those cases medications are documented in the Patient Summary as medication statements or medication requests.\r\nThis section requires either an entry indicating the subject is known not to be on any relevant medication; either an entry indicating that no information is available about medications; or entries summarizing the subject's relevant medications.", "id": "Composition.section:sectionMedications", "max": "1", "min": 0, "path": "Composition.section", "short": "OH Medication Summary Section", "sliceName": "sectionMedications" }, { "definition": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.\r\n\r\nMedication Summary ", "id": "Composition.section:sectionMedications.title", "min": 1, "path": "Composition.section.title", "patternString": "Medicamentos", "short": "Medication Summary section" }, { "id": "Composition.section:sectionMedications.code", "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "10160-0", "system": "http://loinc.org" } ] } }, { "id": "Composition.section:sectionMedications.entry", "min": 1, "path": "Composition.section.entry", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/MedicationRequestOH", "https://fhir.onehealth.com.pe/StructureDefinition/RequestGroupOH" ] } ] }, { "definition": "This section documents the relevant allergies or intolerances (conditions) for that patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy.\r\nAt a minimum, it should list currently active and any relevant historical allergies and adverse reactions.\r\nIf no information about allergies is available, or if no allergies are known this should be clearly documented in the section.", "id": "Composition.section:sectionAllergies", "max": "1", "min": 0, "path": "Composition.section", "short": "OH Allergies and Intolerances Section", "sliceName": "sectionAllergies" }, { "id": "Composition.section:sectionAllergies.title", "min": 1, "path": "Composition.section.title", "patternString": "Alergias e intolerancias" }, { "id": "Composition.section:sectionAllergies.code", "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "48765-2", "system": "http://loinc.org" } ] } }, { "id": "Composition.section:sectionAllergies.entry", "min": 1, "path": "Composition.section.entry", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/AllergyIntoleranceOH" ] } ] }, { "definition": "The OH problem section lists and describes clinical problems or conditions currently being monitored for the patient.", "id": "Composition.section:sectionProblems", "max": "1", "min": 0, "path": "Composition.section", "short": "OH Problems Section", "sliceName": "sectionProblems" }, { "id": "Composition.section:sectionProblems.title", "min": 1, "path": "Composition.section.title", "patternString": "Diagnósticos" }, { "id": "Composition.section:sectionProblems.code", "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "11450-4", "system": "http://loinc.org" } ] } }, { "id": "Composition.section:sectionProblems.entry", "min": 1, "path": "Composition.section.entry", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionProblemListItemOH", "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH" ] } ] }, { "definition": "This section assembles relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results.", "id": "Composition.section:sectionResults", "max": "1", "min": 0, "path": "Composition.section", "short": "OH Results Section", "sliceName": "sectionResults" }, { "id": "Composition.section:sectionResults.title", "min": 1, "path": "Composition.section.title", "patternString": "Resultados diagnósticos" }, { "id": "Composition.section:sectionResults.code", "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "30954-2", "system": "http://loinc.org" } ] } }, { "definition": "Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results.", "id": "Composition.section:sectionResults.entry", "min": 1, "path": "Composition.section.entry", "short": "Relevant observation results collected on the patient or produced on in-vitro biologic ecimens collected from the patient.", "slicing": { "discriminator": [ { "path": "resolve()", "type": "type" }, { "path": "resolve()", "type": "profile" } ], "rules": "open" } }, { "id": "Composition.section:sectionResults.entry:results-physicalactivity", "max": "*", "min": 0, "path": "Composition.section.entry", "sliceName": "results-physicalactivity", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsHoursOfSleepOH", "https://fhir.onehealth.com.pe/StructureDefinition/ObsNumberOfStepsOH" ] } ] }, { "id": "Composition.section:sectionResults.entry:results-bloodtype", "max": "*", "min": 0, "path": "Composition.section.entry", "sliceName": "results-bloodtype", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBloodGroupOH", "https://fhir.onehealth.com.pe/StructureDefinition/ObsRhFactorOH" ] } ] }, { "definition": "The history of pregnancy section shall contain information about whether the patient is currently pregnant or not.\r\nIt may contain addition summarizing information about the outcome of earlier pregnancies.", "id": "Composition.section:sectionPregnancyHx", "max": "1", "min": 0, "path": "Composition.section", "short": "OH History of Pregnancy Section", "sliceName": "sectionPregnancyHx" }, { "id": "Composition.section:sectionPregnancyHx.title", "min": 1, "path": "Composition.section.title", "patternString": "Embarazo" }, { "id": "Composition.section:sectionPregnancyHx.code", "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "10162-6", "system": "http://loinc.org" } ] } }, { "id": "Composition.section:sectionPregnancyHx.entry", "min": 1, "path": "Composition.section.entry", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsLastMenstrualPeriodOH", "https://fhir.onehealth.com.pe/StructureDefinition/ObsEDCOH" ] } ] }, { "definition": "This document contains additional documentation captured by the provider related to care provided or planned for the patient that is not supported in any other section of the document.", "id": "Composition.section:sectionAditionalDocumentation", "max": "1", "min": 0, "path": "Composition.section", "short": "OH History of Pregnancy Section", "sliceName": "sectionAditionalDocumentation" }, { "id": "Composition.section:sectionAditionalDocumentation.title", "min": 1, "path": "Composition.section.title", "patternString": "Documentación Adicional" }, { "id": "Composition.section:sectionAditionalDocumentation.code", "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "77599-9", "system": "http://loinc.org" } ] } }, { "id": "Composition.section:sectionAditionalDocumentation.entry", "min": 1, "path": "Composition.section.entry", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/DocumentReferenceOH" ] } ] } ] }, "fhirVersion": "4.0.1", "id": "CompositionOutpatientProgressNoteOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "cda", "name": "CDA (R2)", "uri": "http://hl7.org/v3/cda" }, { "identity": "fhirdocumentreference", "name": "FHIR DocumentReference", "uri": "http://hl7.org/fhir/documentreference" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" } ], "meta": { "lastUpdated": "2024-04-12T17:46:15.758788+00:00", "versionId": "MTcxMjk0Mzk3NTc1ODc4ODAwMA" }, "name": "CompositionOutpatientProgressNoteOHositionOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Composition" }, "comment": "While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.", "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).", "id": "Composition", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "rim", "map": "Document[classCode=\"DOC\" and moodCode=\"EVN\" and isNormalAct()]" }, { "identity": "cda", "map": "ClinicalDocument" }, { "identity": "fhirdocumentreference", "map": "when described by DocumentReference" } ], "max": "*", "min": 0, "path": "Composition", "short": "A set of resources composed into a single coherent clinical statement with clinical attestation" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Composition.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Composition.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Composition.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Composition.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.meta.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.meta.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.meta.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.meta.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Meta.versionId" }, "comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.", "id": "Composition.meta.versionId", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Composition.meta.versionId", "short": "Version specific identifier", "type": [ { "code": "id" } ] }, { "base": { "max": "1", "min": 0, "path": "Meta.lastUpdated" }, "comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http.html#read) interaction.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When the resource last changed - e.g. when the version changed.", "id": "Composition.meta.lastUpdated", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Composition.meta.lastUpdated", "short": "When the resource version last changed", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Meta.source" }, "comment": "In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. \n\nThis element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Informar el sistema del cual proviene la información (Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)", "id": "Composition.meta.source", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Composition.meta.source", "short": "Informar el sistema del cual proviene la información (Ej: http://www.onehealth.com/PRM o http://www.onehealth.com/HIS)", "type": [ { "code": "uri" } ] }, { "base": { "max": "*", "min": 0, "path": "Meta.profile" }, "comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).", "id": "Composition.meta.profile", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "path": "Composition.meta.profile", "short": "Profiles this resource claims to conform to", "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Meta.security" }, "binding": { "description": "Security Labels from the Healthcare Privacy and Security Classification System.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SecurityLabels" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/security-labels" }, "comment": "The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.", "id": "Composition.meta.security", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "path": "Composition.meta.security", "short": "Security Labels applied to this resource", "type": [ { "code": "Coding" } ] }, { "base": { "max": "*", "min": 0, "path": "Meta.tag" }, "binding": { "description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\".", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Tags" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/common-tags" }, "comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.", "id": "Composition.meta.tag", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "path": "Composition.meta.tag", "short": "Tags applied to this resource", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Composition.implicitRules", "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, "max": "1", "min": 0, "path": "Composition.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Composition.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Composition.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Composition.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "Composition.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "Composition.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Composition.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "Composition.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.identifier" }, "comment": "Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.", "id": "Composition.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": "Document.id / Document.setId" }, { "identity": "cda", "map": ".setId" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.masterIdentifier" } ], "max": "0", "min": 0, "path": "Composition.identifier", "short": "Version-independent identifier for the Composition", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 1, "path": "Composition.status" }, "binding": { "description": "The workflow/clinical status of the composition.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CompositionStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/composition-status|4.0.1" }, "comment": "If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag \"entered-in-error\" is why this element is labeled as a modifier of other elements. \n\nSome reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.", "id": "Composition.status", "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, "mapping": [ { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\"; final: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseComposition\", code) and isNormalAct()]); amended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseComposition\", code) and isNormalAct() and statusCode=\"completed\"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\"" }, { "identity": "cda", "map": "n/a" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.status" } ], "max": "1", "min": 1, "path": "Composition.status", "requirements": "Need to be able to mark interim, amended, or withdrawn compositions or documents.", "short": "preliminary | final | amended | entered-in-error", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Composition.type" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-typecodes" }, "comment": "For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies that this composition refers to a Attending Outpatient Progress note (Loinc \"100441-5\")\r\n", "id": "Composition.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": "./code" }, { "identity": "cda", "map": ".code" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.type" } ], "max": "1", "min": 1, "path": "Composition.type", "patternCodeableConcept": { "coding": [ { "code": "100441-5", "system": "http://loinc.org" } ] }, "requirements": "Key metadata element describing the composition, used in searching/filtering.", "short": "Kind of composition (\"Attending Outpatient Progress note\")", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.category" }, "binding": { "description": "High-level kind of a clinical document at a macro level.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentCategory" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/document-classcodes" }, "comment": "This is a metadata field from [XDS/MHD](http://wiki.ihe.net/index.php?title=Mobile_access_to_Health_Documents_(MHD)).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.", "id": "Composition.category", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.subject" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" }, { "identity": "cda", "map": "n/a" }, { "identity": "fhirdocumentreference", "map": "DocumenttReference.category" } ], "max": "0", "min": 0, "path": "Composition.category", "requirements": "Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents.", "short": "Categorization of Composition", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.subject" }, "comment": "For clinical documents, this is usually the patient.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).", "id": "Composition.subject", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "rim", "map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]" }, { "identity": "cda", "map": ".recordTarget" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.subject" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 1, "path": "Composition.subject", "requirements": "Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.", "short": "Who and/or what the composition is about", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.encounter" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes the clinical encounter or type of care this documentation is associated with.", "id": "Composition.encounter", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.context" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "rim", "map": "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])" }, { "identity": "cda", "map": ".componentOf.encompassingEncounter" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.context.encounter" } ], "max": "1", "min": 1, "path": "Composition.encounter", "requirements": "Provides context for the composition and supports searching.", "short": "Context of the Composition", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Composition.date" }, "comment": "The Last Modified Date on the composition may be after the date of the document was attested without being changed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The composition editing time, when the composition was last logically changed by the author.", "id": "Composition.date", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "rim", "map": ".effectiveTime[type=\"TS\"]" }, { "identity": "cda", "map": ".effectiveTime" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.content.attachment.date, DocumentReference.created" } ], "max": "1", "min": 1, "path": "Composition.date", "requirements": "dateTime is used for tracking, organizing versions and searching. Note that this is the time of *authoring*. When packaged in a document, [Bundle.timestamp](bundle-definitions.html#Bundle.timestamp) is the date of packaging.", "short": "Composition editing time", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "*", "min": 1, "path": "Composition.author" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies who is responsible for the information in the composition, not necessarily who typed it in.", "id": "Composition.author", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer" }, { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "cda", "map": ".author.assignedAuthor" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.agent" } ], "max": "*", "min": 1, "path": "Composition.author", "requirements": "Identifies who is responsible for the content.", "short": "Who and/or what authored the composition", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 1, "path": "Composition.title" }, "comment": "For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a \"consultation\" or \"progress note\"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Official human-readable label for the composition.", "id": "Composition.title", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "./title" }, { "identity": "cda", "map": ".title" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.description, DocumentReference.content.attachment.title" } ], "max": "1", "min": 1, "path": "Composition.title", "short": "Human Readable name/title", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.confidentiality" }, "binding": { "description": "Codes specifying the level of confidentiality of the composition.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentConfidentiality" } ], "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26" }, "comment": "The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The code specifying the level of confidentiality of the Composition.", "id": "Composition.confidentiality", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".confidentialityCode" }, { "identity": "cda", "map": ".confidentialityCode" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.securityLabel" } ], "max": "1", "min": 0, "path": "Composition.confidentiality", "short": "As defined by affinity domain", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.attester" }, "comment": "Only list each attester once.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A participant who has attested to the accuracy of the composition/document.", "id": "Composition.attester", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "cda", "map": ".authenticator/.legalAuthenticator" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.authenticator" } ], "max": "0", "min": 0, "path": "Composition.attester", "requirements": "Identifies responsibility for the accuracy of the composition content.", "short": "Attests to accuracy of composition", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.attester.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.attester.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.attester.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.attester.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.attester.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.attester.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Composition.attester.mode" }, "binding": { "description": "The way in which a person authenticated a composition.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CompositionAttestationMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The type of attestation the authenticator offers.", "id": "Composition.attester.mode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "unique(./modeCode)" }, { "identity": "cda", "map": "implied by .authenticator/.legalAuthenticator" } ], "max": "1", "min": 1, "path": "Composition.attester.mode", "requirements": "Indicates the level of authority of the attestation.", "short": "personal | professional | legal | official", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.attester.time" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When the composition was attested by the party.", "id": "Composition.attester.time", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./time[type=\"TS\" and isNormalDatatype()]" }, { "identity": "cda", "map": ".authenticator.time" } ], "max": "1", "min": 0, "path": "Composition.attester.time", "requirements": "Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).", "short": "When the composition was attested", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.attester.party" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Who attested the composition in the specified way.", "id": "Composition.attester.party", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.witness" }, { "identity": "rim", "map": "./role[classCode=\"ASSIGNED\" and isNormalRole]/player[determinerCode=\"INST\" and classCode=(\"DEV\", \"PSN\") and isNormalEntity()] or ./role[classCode=\"ASSIGNED\" and isNormalRole and not(player)]/scoper[determinerCode=\"INST\" and classCode=\"ORG\" and isNormalEntity()]" }, { "identity": "cda", "map": ".authenticator.assignedEnttty" } ], "max": "1", "min": 0, "path": "Composition.attester.party", "requirements": "Identifies who has taken on the responsibility for accuracy of the composition content.", "short": "Who attested the composition", "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", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.custodian" }, "comment": "This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.", "id": "Composition.custodian", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]" }, { "identity": "cda", "map": ".custodian.assignedCustodian" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.custodian" } ], "max": "1", "min": 0, "path": "Composition.custodian", "requirements": "Identifies where to go to find the current version, where to report issues, etc.", "short": "Organization which maintains the composition", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.relatesTo" }, "comment": "A document is a version specific composition.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Relationships that this composition has with other compositions or documents that already exist.", "id": "Composition.relatesTo", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship" }, { "identity": "cda", "map": ".relatedDocument" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.relatesTo" } ], "max": "0", "min": 0, "path": "Composition.relatesTo", "short": "Relationships to other compositions/documents", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.relatesTo.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.relatesTo.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.relatesTo.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.relatesTo.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.relatesTo.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.relatesTo.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Composition.relatesTo.code" }, "binding": { "description": "The type of relationship between documents.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentRelationshipType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1" }, "comment": "If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The type of relationship that this composition has with anther composition or document.", "id": "Composition.relatesTo.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship.typeCode" }, { "identity": "cda", "map": ".relatedDocument.typeCode" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.relatesTo.code" } ], "max": "1", "min": 1, "path": "Composition.relatesTo.code", "short": "replaces | transforms | signs | appends", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Composition.relatesTo.target[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The target composition/document of this relationship.", "id": "Composition.relatesTo.target[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id" }, { "identity": "cda", "map": ".relatedDocument.id" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.relatesTo.target" } ], "max": "1", "min": 1, "path": "Composition.relatesTo.target[x]", "short": "Target of the relationship", "type": [ { "code": "Identifier" }, { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Composition" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.event" }, "comment": "The event needs to be consistent with the type element, though can provide further information if desired.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The clinical service, such as a colonoscopy or an appendectomy, being documented.", "id": "Composition.event", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']" }, { "identity": "cda", "map": ".documentationOf.serviceEvent" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.event" } ], "max": "0", "min": 0, "path": "Composition.event", "requirements": "Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.", "short": "The clinical service(s) being documented", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.event.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.event.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.event.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.event.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.event.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.event.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.event.code" }, "binding": { "description": "This list of codes represents the main clinical acts being documented.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DocumentEventType" } ], "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActCode" }, "comment": "An event can further specialize the act inherent in the typeCode, such as where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.", "id": "Composition.event.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".code" }, { "identity": "cda", "map": ".code" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.event.code" } ], "max": "*", "min": 0, "path": "Composition.event.code", "short": "Code(s) that apply to the event being documented", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.event.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.", "id": "Composition.event.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".effectiveTime" }, { "identity": "cda", "map": ".effectiveTime" }, { "identity": "fhirdocumentreference", "map": "DocumentReference.event.period" } ], "max": "1", "min": 0, "path": "Composition.event.period", "short": "The period covered by the documentation", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.event.detail" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.", "id": "Composition.event.detail", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=\"SUBJ\"].target" }, { "identity": "cda", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.event.detail", "short": "The event(s) being documented", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section" }, "constraint": [ { "expression": "text.exists() or entry.exists() or section.exists()", "human": "A section must contain at least one of text, entries, or sub-sections", "key": "cmp-1", "severity": "error", "xpath": "exists(f:text) or exists(f:entry) or exists(f:section)" }, { "expression": "emptyReason.empty() or entry.empty()", "human": "A section can only have an emptyReason if it is empty", "key": "cmp-2", "severity": "error", "xpath": "not(exists(f:emptyReason) and exists(f:entry))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The root of the sections that make up the Attending Outpatient Progress note Composition.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Section" } ], "id": "Composition.section", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.structuredBody.component.section" } ], "max": "*", "min": 0, "path": "Composition.section", "short": "Sections composing the Attending Outpatient Progress note Composition", "slicing": { "discriminator": [ { "path": "code", "type": "pattern" } ], "ordered": false, "rules": "open" }, "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.section.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.section.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.section.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.section.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.section.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "alias": [ "header", "label", "caption" ], "base": { "max": "1", "min": 0, "path": "Composition.section.title" }, "comment": "The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.", "id": "Composition.section.title", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./title" }, { "identity": "cda", "map": ".title" } ], "max": "1", "min": 0, "path": "Composition.section.title", "requirements": "Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.", "short": "Label for section (e.g. for ToC)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-section-codes" }, "comment": "The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. \n\nIf the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code identifying the kind of content contained within the section. This must be consistent with the section title.", "id": "Composition.section.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./code" }, { "identity": "cda", "map": ".code" } ], "max": "1", "min": 1, "path": "Composition.section.code", "requirements": "Provides computable standardized labels to topics within the document.", "short": "Classification of section (recommended)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.author" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies who is responsible for the information in this section, not necessarily who typed it in.", "id": "Composition.section.author", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "cda", "map": ".author.assignedAuthor" } ], "max": "*", "min": 0, "path": "Composition.section.author", "requirements": "Identifies who is responsible for the content.", "short": "Who and/or what authored the section", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.focus" }, "comment": "Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).", "id": "Composition.section.focus", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "cda", "map": ".subject? (CDA did not differentiate between subject and focus)" } ], "max": "1", "min": 0, "path": "Composition.section.focus", "short": "Who/what the section is about, when it is not about the subject of composition", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.text" }, "comment": "Document profiles may define what content should be represented in the narrative to ensure clinical safety.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative.", "id": "Composition.section.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".text" }, { "identity": "cda", "map": ".text" } ], "max": "1", "min": 1, "path": "Composition.section.text", "short": "Text summary of the section, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.mode" }, "binding": { "description": "The processing mode that applies to this section.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-mode|4.0.1" }, "comment": "This element is labeled as a modifier because a change list must not be misunderstood as a complete list.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.", "id": "Composition.section.mode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.mode", "requirements": "Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.", "short": "working | snapshot | changes", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.orderedBy" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-order" }, "comment": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the order applied to the items in the section entries.", "id": "Composition.section.orderedBy", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.orderedBy", "requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.", "short": "Order of section entries", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.entry" }, "comment": "If there are no entries in the list, an emptyReason SHOULD be provided.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to the actual resource from which the narrative in the section is derived.", "id": "Composition.section.entry", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" }, { "identity": "cda", "map": ".entry" } ], "max": "*", "min": 0, "path": "Composition.section.entry", "short": "A reference to data that supports this section", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.emptyReason" }, "binding": { "description": "If a section is empty, why it is empty.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionEmptyReason" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/list-empty-reason" }, "comment": "The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.", "id": "Composition.section.emptyReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]" }, { "identity": "cda", "map": "n/a" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.emptyReason", "requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.", "short": "Why the section is empty", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.section" }, "comment": "Nested sections are primarily used to help human readers navigate to particular portions of the document.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Composition.section", "definition": "A nested sub-section within this section.", "id": "Composition.section.section", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.section" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.section", "short": "Nested Section" }, { "base": { "max": "*", "min": 0, "path": "Composition.section" }, "constraint": [ { "expression": "text.exists() or entry.exists() or section.exists()", "human": "A section must contain at least one of text, entries, or sub-sections", "key": "cmp-1", "severity": "error", "xpath": "exists(f:text) or exists(f:entry) or exists(f:section)" }, { "expression": "emptyReason.empty() or entry.empty()", "human": "A section can only have an emptyReason if it is empty", "key": "cmp-2", "severity": "error", "xpath": "not(exists(f:emptyReason) and exists(f:entry))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The section includes direct observations made by a clinician. The examination may include the use of simple instruments and may also describe simple maneuvers performed directly on the patients body. It also includes observations made by the examining clinician using only inspection, palpation, auscultation, and percussion. It does not include laboratory or imaging findings. The exam may be limited to pertinent body systems based on the patients chief complaint or it may include a comprehensive examination. The examination may be reported as a collection of random clinical statements or it may be reported categorically. ", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Section" } ], "id": "Composition.section:sectionPhysicalExam", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.structuredBody.component.section" } ], "max": "1", "min": 0, "path": "Composition.section", "short": "OH Physical Exam Section", "sliceName": "sectionPhysicalExam", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.section:sectionPhysicalExam.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.section:sectionPhysicalExam.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.section.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.section:sectionPhysicalExam.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.section.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "alias": [ "header", "label", "caption" ], "base": { "max": "1", "min": 0, "path": "Composition.section.title" }, "comment": "The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.", "id": "Composition.section:sectionPhysicalExam.title", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./title" }, { "identity": "cda", "map": ".title" } ], "max": "1", "min": 1, "path": "Composition.section.title", "patternString": "Exámen físico", "requirements": "Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.", "short": "Label for section (e.g. for ToC)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-section-codes" }, "comment": "The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. \n\nIf the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code identifying the kind of content contained within the section. This must be consistent with the section title.", "id": "Composition.section:sectionPhysicalExam.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./code" }, { "identity": "cda", "map": ".code" } ], "max": "1", "min": 1, "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "29545-1", "system": "http://loinc.org" } ] }, "requirements": "Provides computable standardized labels to topics within the document.", "short": "Classification of section (recommended)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.author" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies who is responsible for the information in this section, not necessarily who typed it in.", "id": "Composition.section:sectionPhysicalExam.author", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "cda", "map": ".author.assignedAuthor" } ], "max": "*", "min": 0, "path": "Composition.section.author", "requirements": "Identifies who is responsible for the content.", "short": "Who and/or what authored the section", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.focus" }, "comment": "Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).", "id": "Composition.section:sectionPhysicalExam.focus", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "cda", "map": ".subject? (CDA did not differentiate between subject and focus)" } ], "max": "1", "min": 0, "path": "Composition.section.focus", "short": "Who/what the section is about, when it is not about the subject of composition", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.text" }, "comment": "Document profiles may define what content should be represented in the narrative to ensure clinical safety.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative.", "id": "Composition.section:sectionPhysicalExam.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".text" }, { "identity": "cda", "map": ".text" } ], "max": "1", "min": 1, "path": "Composition.section.text", "short": "Text summary of the section, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.mode" }, "binding": { "description": "The processing mode that applies to this section.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-mode|4.0.1" }, "comment": "This element is labeled as a modifier because a change list must not be misunderstood as a complete list.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.", "id": "Composition.section:sectionPhysicalExam.mode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.mode", "requirements": "Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.", "short": "working | snapshot | changes", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.orderedBy" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-order" }, "comment": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the order applied to the items in the section entries.", "id": "Composition.section:sectionPhysicalExam.orderedBy", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.orderedBy", "requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.", "short": "Order of section entries", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.entry" }, "comment": "If there are no entries in the list, an emptyReason SHOULD be provided.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to the actual resource from which the narrative in the section is derived.", "id": "Composition.section:sectionPhysicalExam.entry", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" }, { "identity": "cda", "map": ".entry" } ], "max": "*", "min": 1, "path": "Composition.section.entry", "short": "A reference to data that supports this section", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBodyHeightOH", "https://fhir.onehealth.com.pe/StructureDefinition/ObsBodyWeightOH", "https://fhir.onehealth.com.pe/StructureDefinition/ObsBMIOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.emptyReason" }, "binding": { "description": "If a section is empty, why it is empty.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionEmptyReason" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/list-empty-reason" }, "comment": "The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.", "id": "Composition.section:sectionPhysicalExam.emptyReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]" }, { "identity": "cda", "map": "n/a" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.emptyReason", "requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.", "short": "Why the section is empty", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.section" }, "comment": "Nested sections are primarily used to help human readers navigate to particular portions of the document.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Composition.section", "definition": "A nested sub-section within this section.", "id": "Composition.section:sectionPhysicalExam.section", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.section" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.section", "short": "Nested Section" }, { "base": { "max": "*", "min": 0, "path": "Composition.section" }, "constraint": [ { "expression": "text.exists() or entry.exists() or section.exists()", "human": "A section must contain at least one of text, entries, or sub-sections", "key": "cmp-1", "severity": "error", "xpath": "exists(f:text) or exists(f:entry) or exists(f:section)" }, { "expression": "emptyReason.empty() or entry.empty()", "human": "A section can only have an emptyReason if it is empty", "key": "cmp-2", "severity": "error", "xpath": "not(exists(f:emptyReason) and exists(f:entry))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The medication summary section contains a description of the patient's medications relevant for the scope of the patient summary.\r\nThe actual content could depend on the jurisdiction, it could report:\r\n- the currently active medications; \r\n- the current and past medications considered relevant by the authoring GP; \r\n- the patient prescriptions or dispensations automatically extracted by a EAPB, regional or a national EHR.\r\n\r\nIn those cases medications are documented in the Patient Summary as medication statements or medication requests.\r\nThis section requires either an entry indicating the subject is known not to be on any relevant medication; either an entry indicating that no information is available about medications; or entries summarizing the subject's relevant medications.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Section" } ], "id": "Composition.section:sectionMedications", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.structuredBody.component.section" } ], "max": "1", "min": 0, "path": "Composition.section", "short": "OH Medication Summary Section", "sliceName": "sectionMedications", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.section:sectionMedications.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.section:sectionMedications.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.section.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.section:sectionMedications.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.section.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "alias": [ "header", "label", "caption" ], "base": { "max": "1", "min": 0, "path": "Composition.section.title" }, "comment": "The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.\r\n\r\nMedication Summary ", "id": "Composition.section:sectionMedications.title", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./title" }, { "identity": "cda", "map": ".title" } ], "max": "1", "min": 1, "path": "Composition.section.title", "patternString": "Medicamentos", "requirements": "Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.", "short": "Medication Summary section", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-section-codes" }, "comment": "The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. \n\nIf the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code identifying the kind of content contained within the section. This must be consistent with the section title.", "id": "Composition.section:sectionMedications.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./code" }, { "identity": "cda", "map": ".code" } ], "max": "1", "min": 1, "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "10160-0", "system": "http://loinc.org" } ] }, "requirements": "Provides computable standardized labels to topics within the document.", "short": "Classification of section (recommended)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.author" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies who is responsible for the information in this section, not necessarily who typed it in.", "id": "Composition.section:sectionMedications.author", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "cda", "map": ".author.assignedAuthor" } ], "max": "*", "min": 0, "path": "Composition.section.author", "requirements": "Identifies who is responsible for the content.", "short": "Who and/or what authored the section", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.focus" }, "comment": "Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).", "id": "Composition.section:sectionMedications.focus", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "cda", "map": ".subject? (CDA did not differentiate between subject and focus)" } ], "max": "1", "min": 0, "path": "Composition.section.focus", "short": "Who/what the section is about, when it is not about the subject of composition", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.text" }, "comment": "Document profiles may define what content should be represented in the narrative to ensure clinical safety.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative.", "id": "Composition.section:sectionMedications.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".text" }, { "identity": "cda", "map": ".text" } ], "max": "1", "min": 1, "path": "Composition.section.text", "short": "Text summary of the section, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.mode" }, "binding": { "description": "The processing mode that applies to this section.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-mode|4.0.1" }, "comment": "This element is labeled as a modifier because a change list must not be misunderstood as a complete list.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.", "id": "Composition.section:sectionMedications.mode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.mode", "requirements": "Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.", "short": "working | snapshot | changes", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.orderedBy" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-order" }, "comment": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the order applied to the items in the section entries.", "id": "Composition.section:sectionMedications.orderedBy", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.orderedBy", "requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.", "short": "Order of section entries", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.entry" }, "comment": "If there are no entries in the list, an emptyReason SHOULD be provided.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to the actual resource from which the narrative in the section is derived.", "id": "Composition.section:sectionMedications.entry", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" }, { "identity": "cda", "map": ".entry" } ], "max": "*", "min": 1, "path": "Composition.section.entry", "short": "A reference to data that supports this section", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/MedicationRequestOH", "https://fhir.onehealth.com.pe/StructureDefinition/RequestGroupOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.emptyReason" }, "binding": { "description": "If a section is empty, why it is empty.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionEmptyReason" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/list-empty-reason" }, "comment": "The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.", "id": "Composition.section:sectionMedications.emptyReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]" }, { "identity": "cda", "map": "n/a" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.emptyReason", "requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.", "short": "Why the section is empty", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.section" }, "comment": "Nested sections are primarily used to help human readers navigate to particular portions of the document.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Composition.section", "definition": "A nested sub-section within this section.", "id": "Composition.section:sectionMedications.section", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.section" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.section", "short": "Nested Section" }, { "base": { "max": "*", "min": 0, "path": "Composition.section" }, "constraint": [ { "expression": "text.exists() or entry.exists() or section.exists()", "human": "A section must contain at least one of text, entries, or sub-sections", "key": "cmp-1", "severity": "error", "xpath": "exists(f:text) or exists(f:entry) or exists(f:section)" }, { "expression": "emptyReason.empty() or entry.empty()", "human": "A section can only have an emptyReason if it is empty", "key": "cmp-2", "severity": "error", "xpath": "not(exists(f:emptyReason) and exists(f:entry))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This section documents the relevant allergies or intolerances (conditions) for that patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy.\r\nAt a minimum, it should list currently active and any relevant historical allergies and adverse reactions.\r\nIf no information about allergies is available, or if no allergies are known this should be clearly documented in the section.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Section" } ], "id": "Composition.section:sectionAllergies", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.structuredBody.component.section" } ], "max": "1", "min": 0, "path": "Composition.section", "short": "OH Allergies and Intolerances Section", "sliceName": "sectionAllergies", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.section:sectionAllergies.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.section:sectionAllergies.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.section.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.section:sectionAllergies.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.section.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "alias": [ "header", "label", "caption" ], "base": { "max": "1", "min": 0, "path": "Composition.section.title" }, "comment": "The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.", "id": "Composition.section:sectionAllergies.title", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./title" }, { "identity": "cda", "map": ".title" } ], "max": "1", "min": 1, "path": "Composition.section.title", "patternString": "Alergias e intolerancias", "requirements": "Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.", "short": "Label for section (e.g. for ToC)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-section-codes" }, "comment": "The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. \n\nIf the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code identifying the kind of content contained within the section. This must be consistent with the section title.", "id": "Composition.section:sectionAllergies.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./code" }, { "identity": "cda", "map": ".code" } ], "max": "1", "min": 1, "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "48765-2", "system": "http://loinc.org" } ] }, "requirements": "Provides computable standardized labels to topics within the document.", "short": "Classification of section (recommended)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.author" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies who is responsible for the information in this section, not necessarily who typed it in.", "id": "Composition.section:sectionAllergies.author", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "cda", "map": ".author.assignedAuthor" } ], "max": "*", "min": 0, "path": "Composition.section.author", "requirements": "Identifies who is responsible for the content.", "short": "Who and/or what authored the section", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.focus" }, "comment": "Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).", "id": "Composition.section:sectionAllergies.focus", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "cda", "map": ".subject? (CDA did not differentiate between subject and focus)" } ], "max": "1", "min": 0, "path": "Composition.section.focus", "short": "Who/what the section is about, when it is not about the subject of composition", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.text" }, "comment": "Document profiles may define what content should be represented in the narrative to ensure clinical safety.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative.", "id": "Composition.section:sectionAllergies.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".text" }, { "identity": "cda", "map": ".text" } ], "max": "1", "min": 1, "path": "Composition.section.text", "short": "Text summary of the section, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.mode" }, "binding": { "description": "The processing mode that applies to this section.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-mode|4.0.1" }, "comment": "This element is labeled as a modifier because a change list must not be misunderstood as a complete list.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.", "id": "Composition.section:sectionAllergies.mode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.mode", "requirements": "Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.", "short": "working | snapshot | changes", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.orderedBy" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-order" }, "comment": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the order applied to the items in the section entries.", "id": "Composition.section:sectionAllergies.orderedBy", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.orderedBy", "requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.", "short": "Order of section entries", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.entry" }, "comment": "If there are no entries in the list, an emptyReason SHOULD be provided.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to the actual resource from which the narrative in the section is derived.", "id": "Composition.section:sectionAllergies.entry", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" }, { "identity": "cda", "map": ".entry" } ], "max": "*", "min": 1, "path": "Composition.section.entry", "short": "A reference to data that supports this section", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/AllergyIntoleranceOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.emptyReason" }, "binding": { "description": "If a section is empty, why it is empty.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionEmptyReason" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/list-empty-reason" }, "comment": "The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.", "id": "Composition.section:sectionAllergies.emptyReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]" }, { "identity": "cda", "map": "n/a" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.emptyReason", "requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.", "short": "Why the section is empty", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.section" }, "comment": "Nested sections are primarily used to help human readers navigate to particular portions of the document.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Composition.section", "definition": "A nested sub-section within this section.", "id": "Composition.section:sectionAllergies.section", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.section" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.section", "short": "Nested Section" }, { "base": { "max": "*", "min": 0, "path": "Composition.section" }, "constraint": [ { "expression": "text.exists() or entry.exists() or section.exists()", "human": "A section must contain at least one of text, entries, or sub-sections", "key": "cmp-1", "severity": "error", "xpath": "exists(f:text) or exists(f:entry) or exists(f:section)" }, { "expression": "emptyReason.empty() or entry.empty()", "human": "A section can only have an emptyReason if it is empty", "key": "cmp-2", "severity": "error", "xpath": "not(exists(f:emptyReason) and exists(f:entry))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The OH problem section lists and describes clinical problems or conditions currently being monitored for the patient.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Section" } ], "id": "Composition.section:sectionProblems", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.structuredBody.component.section" } ], "max": "1", "min": 0, "path": "Composition.section", "short": "OH Problems Section", "sliceName": "sectionProblems", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.section:sectionProblems.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.section:sectionProblems.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.section.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.section:sectionProblems.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.section.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "alias": [ "header", "label", "caption" ], "base": { "max": "1", "min": 0, "path": "Composition.section.title" }, "comment": "The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.", "id": "Composition.section:sectionProblems.title", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./title" }, { "identity": "cda", "map": ".title" } ], "max": "1", "min": 1, "path": "Composition.section.title", "patternString": "Diagnósticos", "requirements": "Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.", "short": "Label for section (e.g. for ToC)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-section-codes" }, "comment": "The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. \n\nIf the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code identifying the kind of content contained within the section. This must be consistent with the section title.", "id": "Composition.section:sectionProblems.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./code" }, { "identity": "cda", "map": ".code" } ], "max": "1", "min": 1, "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "11450-4", "system": "http://loinc.org" } ] }, "requirements": "Provides computable standardized labels to topics within the document.", "short": "Classification of section (recommended)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.author" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies who is responsible for the information in this section, not necessarily who typed it in.", "id": "Composition.section:sectionProblems.author", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "cda", "map": ".author.assignedAuthor" } ], "max": "*", "min": 0, "path": "Composition.section.author", "requirements": "Identifies who is responsible for the content.", "short": "Who and/or what authored the section", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.focus" }, "comment": "Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).", "id": "Composition.section:sectionProblems.focus", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "cda", "map": ".subject? (CDA did not differentiate between subject and focus)" } ], "max": "1", "min": 0, "path": "Composition.section.focus", "short": "Who/what the section is about, when it is not about the subject of composition", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.text" }, "comment": "Document profiles may define what content should be represented in the narrative to ensure clinical safety.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative.", "id": "Composition.section:sectionProblems.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".text" }, { "identity": "cda", "map": ".text" } ], "max": "1", "min": 1, "path": "Composition.section.text", "short": "Text summary of the section, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.mode" }, "binding": { "description": "The processing mode that applies to this section.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-mode|4.0.1" }, "comment": "This element is labeled as a modifier because a change list must not be misunderstood as a complete list.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.", "id": "Composition.section:sectionProblems.mode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.mode", "requirements": "Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.", "short": "working | snapshot | changes", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.orderedBy" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-order" }, "comment": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the order applied to the items in the section entries.", "id": "Composition.section:sectionProblems.orderedBy", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.orderedBy", "requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.", "short": "Order of section entries", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.entry" }, "comment": "If there are no entries in the list, an emptyReason SHOULD be provided.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to the actual resource from which the narrative in the section is derived.", "id": "Composition.section:sectionProblems.entry", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" }, { "identity": "cda", "map": ".entry" } ], "max": "*", "min": 1, "path": "Composition.section.entry", "short": "A reference to data that supports this section", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionProblemListItemOH", "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.emptyReason" }, "binding": { "description": "If a section is empty, why it is empty.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionEmptyReason" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/list-empty-reason" }, "comment": "The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.", "id": "Composition.section:sectionProblems.emptyReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]" }, { "identity": "cda", "map": "n/a" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.emptyReason", "requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.", "short": "Why the section is empty", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.section" }, "comment": "Nested sections are primarily used to help human readers navigate to particular portions of the document.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Composition.section", "definition": "A nested sub-section within this section.", "id": "Composition.section:sectionProblems.section", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.section" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.section", "short": "Nested Section" }, { "base": { "max": "*", "min": 0, "path": "Composition.section" }, "constraint": [ { "expression": "text.exists() or entry.exists() or section.exists()", "human": "A section must contain at least one of text, entries, or sub-sections", "key": "cmp-1", "severity": "error", "xpath": "exists(f:text) or exists(f:entry) or exists(f:section)" }, { "expression": "emptyReason.empty() or entry.empty()", "human": "A section can only have an emptyReason if it is empty", "key": "cmp-2", "severity": "error", "xpath": "not(exists(f:emptyReason) and exists(f:entry))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This section assembles relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Section" } ], "id": "Composition.section:sectionResults", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.structuredBody.component.section" } ], "max": "1", "min": 0, "path": "Composition.section", "short": "OH Results Section", "sliceName": "sectionResults", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.section:sectionResults.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.section:sectionResults.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.section.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.section:sectionResults.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.section.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "alias": [ "header", "label", "caption" ], "base": { "max": "1", "min": 0, "path": "Composition.section.title" }, "comment": "The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.", "id": "Composition.section:sectionResults.title", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./title" }, { "identity": "cda", "map": ".title" } ], "max": "1", "min": 1, "path": "Composition.section.title", "patternString": "Resultados diagnósticos", "requirements": "Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.", "short": "Label for section (e.g. for ToC)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-section-codes" }, "comment": "The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. \n\nIf the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code identifying the kind of content contained within the section. This must be consistent with the section title.", "id": "Composition.section:sectionResults.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./code" }, { "identity": "cda", "map": ".code" } ], "max": "1", "min": 1, "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "30954-2", "system": "http://loinc.org" } ] }, "requirements": "Provides computable standardized labels to topics within the document.", "short": "Classification of section (recommended)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.author" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies who is responsible for the information in this section, not necessarily who typed it in.", "id": "Composition.section:sectionResults.author", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "cda", "map": ".author.assignedAuthor" } ], "max": "*", "min": 0, "path": "Composition.section.author", "requirements": "Identifies who is responsible for the content.", "short": "Who and/or what authored the section", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.focus" }, "comment": "Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).", "id": "Composition.section:sectionResults.focus", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "cda", "map": ".subject? (CDA did not differentiate between subject and focus)" } ], "max": "1", "min": 0, "path": "Composition.section.focus", "short": "Who/what the section is about, when it is not about the subject of composition", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.text" }, "comment": "Document profiles may define what content should be represented in the narrative to ensure clinical safety.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative.", "id": "Composition.section:sectionResults.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".text" }, { "identity": "cda", "map": ".text" } ], "max": "1", "min": 1, "path": "Composition.section.text", "short": "Text summary of the section, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.mode" }, "binding": { "description": "The processing mode that applies to this section.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-mode|4.0.1" }, "comment": "This element is labeled as a modifier because a change list must not be misunderstood as a complete list.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.", "id": "Composition.section:sectionResults.mode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.mode", "requirements": "Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.", "short": "working | snapshot | changes", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.orderedBy" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-order" }, "comment": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the order applied to the items in the section entries.", "id": "Composition.section:sectionResults.orderedBy", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.orderedBy", "requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.", "short": "Order of section entries", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.entry" }, "comment": "If there are no entries in the list, an emptyReason SHOULD be provided.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results.", "id": "Composition.section:sectionResults.entry", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" }, { "identity": "cda", "map": ".entry" } ], "max": "*", "min": 1, "path": "Composition.section.entry", "short": "Relevant observation results collected on the patient or produced on in-vitro biologic ecimens collected from the patient.", "slicing": { "discriminator": [ { "path": "resolve()", "type": "type" }, { "path": "resolve()", "type": "profile" } ], "rules": "open" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.entry" }, "comment": "If there are no entries in the list, an emptyReason SHOULD be provided.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results.", "id": "Composition.section:sectionResults.entry:results-physicalactivity", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" }, { "identity": "cda", "map": ".entry" } ], "max": "*", "min": 0, "path": "Composition.section.entry", "short": "Relevant observation results collected on the patient or produced on in-vitro biologic ecimens collected from the patient.", "sliceName": "results-physicalactivity", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsHoursOfSleepOH", "https://fhir.onehealth.com.pe/StructureDefinition/ObsNumberOfStepsOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.entry" }, "comment": "If there are no entries in the list, an emptyReason SHOULD be provided.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results.", "id": "Composition.section:sectionResults.entry:results-bloodtype", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" }, { "identity": "cda", "map": ".entry" } ], "max": "*", "min": 0, "path": "Composition.section.entry", "short": "Relevant observation results collected on the patient or produced on in-vitro biologic ecimens collected from the patient.", "sliceName": "results-bloodtype", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBloodGroupOH", "https://fhir.onehealth.com.pe/StructureDefinition/ObsRhFactorOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.emptyReason" }, "binding": { "description": "If a section is empty, why it is empty.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionEmptyReason" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/list-empty-reason" }, "comment": "The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.", "id": "Composition.section:sectionResults.emptyReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]" }, { "identity": "cda", "map": "n/a" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.emptyReason", "requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.", "short": "Why the section is empty", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.section" }, "comment": "Nested sections are primarily used to help human readers navigate to particular portions of the document.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Composition.section", "definition": "A nested sub-section within this section.", "id": "Composition.section:sectionResults.section", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.section" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.section", "short": "Nested Section" }, { "base": { "max": "*", "min": 0, "path": "Composition.section" }, "constraint": [ { "expression": "text.exists() or entry.exists() or section.exists()", "human": "A section must contain at least one of text, entries, or sub-sections", "key": "cmp-1", "severity": "error", "xpath": "exists(f:text) or exists(f:entry) or exists(f:section)" }, { "expression": "emptyReason.empty() or entry.empty()", "human": "A section can only have an emptyReason if it is empty", "key": "cmp-2", "severity": "error", "xpath": "not(exists(f:emptyReason) and exists(f:entry))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The history of pregnancy section shall contain information about whether the patient is currently pregnant or not.\r\nIt may contain addition summarizing information about the outcome of earlier pregnancies.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Section" } ], "id": "Composition.section:sectionPregnancyHx", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.structuredBody.component.section" } ], "max": "1", "min": 0, "path": "Composition.section", "short": "OH History of Pregnancy Section", "sliceName": "sectionPregnancyHx", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.section:sectionPregnancyHx.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.section:sectionPregnancyHx.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.section.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.section:sectionPregnancyHx.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.section.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "alias": [ "header", "label", "caption" ], "base": { "max": "1", "min": 0, "path": "Composition.section.title" }, "comment": "The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.", "id": "Composition.section:sectionPregnancyHx.title", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./title" }, { "identity": "cda", "map": ".title" } ], "max": "1", "min": 1, "path": "Composition.section.title", "patternString": "Embarazo", "requirements": "Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.", "short": "Label for section (e.g. for ToC)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-section-codes" }, "comment": "The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. \n\nIf the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code identifying the kind of content contained within the section. This must be consistent with the section title.", "id": "Composition.section:sectionPregnancyHx.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./code" }, { "identity": "cda", "map": ".code" } ], "max": "1", "min": 1, "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "10162-6", "system": "http://loinc.org" } ] }, "requirements": "Provides computable standardized labels to topics within the document.", "short": "Classification of section (recommended)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.author" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies who is responsible for the information in this section, not necessarily who typed it in.", "id": "Composition.section:sectionPregnancyHx.author", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "cda", "map": ".author.assignedAuthor" } ], "max": "*", "min": 0, "path": "Composition.section.author", "requirements": "Identifies who is responsible for the content.", "short": "Who and/or what authored the section", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.focus" }, "comment": "Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).", "id": "Composition.section:sectionPregnancyHx.focus", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "cda", "map": ".subject? (CDA did not differentiate between subject and focus)" } ], "max": "1", "min": 0, "path": "Composition.section.focus", "short": "Who/what the section is about, when it is not about the subject of composition", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.text" }, "comment": "Document profiles may define what content should be represented in the narrative to ensure clinical safety.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative.", "id": "Composition.section:sectionPregnancyHx.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".text" }, { "identity": "cda", "map": ".text" } ], "max": "1", "min": 1, "path": "Composition.section.text", "short": "Text summary of the section, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.mode" }, "binding": { "description": "The processing mode that applies to this section.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-mode|4.0.1" }, "comment": "This element is labeled as a modifier because a change list must not be misunderstood as a complete list.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.", "id": "Composition.section:sectionPregnancyHx.mode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.mode", "requirements": "Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.", "short": "working | snapshot | changes", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.orderedBy" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-order" }, "comment": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the order applied to the items in the section entries.", "id": "Composition.section:sectionPregnancyHx.orderedBy", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.orderedBy", "requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.", "short": "Order of section entries", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.entry" }, "comment": "If there are no entries in the list, an emptyReason SHOULD be provided.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to the actual resource from which the narrative in the section is derived.", "id": "Composition.section:sectionPregnancyHx.entry", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" }, { "identity": "cda", "map": ".entry" } ], "max": "*", "min": 1, "path": "Composition.section.entry", "short": "A reference to data that supports this section", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsLastMenstrualPeriodOH", "https://fhir.onehealth.com.pe/StructureDefinition/ObsEDCOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.emptyReason" }, "binding": { "description": "If a section is empty, why it is empty.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionEmptyReason" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/list-empty-reason" }, "comment": "The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.", "id": "Composition.section:sectionPregnancyHx.emptyReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]" }, { "identity": "cda", "map": "n/a" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.emptyReason", "requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.", "short": "Why the section is empty", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.section" }, "comment": "Nested sections are primarily used to help human readers navigate to particular portions of the document.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Composition.section", "definition": "A nested sub-section within this section.", "id": "Composition.section:sectionPregnancyHx.section", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.section" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.section", "short": "Nested Section" }, { "base": { "max": "*", "min": 0, "path": "Composition.section" }, "constraint": [ { "expression": "text.exists() or entry.exists() or section.exists()", "human": "A section must contain at least one of text, entries, or sub-sections", "key": "cmp-1", "severity": "error", "xpath": "exists(f:text) or exists(f:entry) or exists(f:section)" }, { "expression": "emptyReason.empty() or entry.empty()", "human": "A section can only have an emptyReason if it is empty", "key": "cmp-2", "severity": "error", "xpath": "not(exists(f:emptyReason) and exists(f:entry))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This document contains additional documentation captured by the provider related to care provided or planned for the patient that is not supported in any other section of the document.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Section" } ], "id": "Composition.section:sectionAditionalDocumentation", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.structuredBody.component.section" } ], "max": "1", "min": 0, "path": "Composition.section", "short": "OH History of Pregnancy Section", "sliceName": "sectionAditionalDocumentation", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Composition.section:sectionAditionalDocumentation.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Composition.section:sectionAditionalDocumentation.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Composition.section.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Composition.section:sectionAditionalDocumentation.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Composition.section.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "alias": [ "header", "label", "caption" ], "base": { "max": "1", "min": 0, "path": "Composition.section.title" }, "comment": "The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.", "id": "Composition.section:sectionAditionalDocumentation.title", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./title" }, { "identity": "cda", "map": ".title" } ], "max": "1", "min": 1, "path": "Composition.section.title", "patternString": "Documentación Adicional", "requirements": "Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.", "short": "Label for section (e.g. for ToC)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.code" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/doc-section-codes" }, "comment": "The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. \n\nIf the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A code identifying the kind of content contained within the section. This must be consistent with the section title.", "id": "Composition.section:sectionAditionalDocumentation.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./code" }, { "identity": "cda", "map": ".code" } ], "max": "1", "min": 1, "path": "Composition.section.code", "patternCodeableConcept": { "coding": [ { "code": "77599-9", "system": "http://loinc.org" } ] }, "requirements": "Provides computable standardized labels to topics within the document.", "short": "Classification of section (recommended)", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.author" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies who is responsible for the information in this section, not necessarily who typed it in.", "id": "Composition.section:sectionAditionalDocumentation.author", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]" }, { "identity": "cda", "map": ".author.assignedAuthor" } ], "max": "*", "min": 0, "path": "Composition.section.author", "requirements": "Identifies who is responsible for the content.", "short": "Who and/or what authored the section", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.focus" }, "comment": "Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).", "id": "Composition.section:sectionAditionalDocumentation.focus", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "cda", "map": ".subject? (CDA did not differentiate between subject and focus)" } ], "max": "1", "min": 0, "path": "Composition.section.focus", "short": "Who/what the section is about, when it is not about the subject of composition", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.text" }, "comment": "Document profiles may define what content should be represented in the narrative to ensure clinical safety.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative.", "id": "Composition.section:sectionAditionalDocumentation.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".text" }, { "identity": "cda", "map": ".text" } ], "max": "1", "min": 1, "path": "Composition.section.text", "short": "Text summary of the section, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.mode" }, "binding": { "description": "The processing mode that applies to this section.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-mode|4.0.1" }, "comment": "This element is labeled as a modifier because a change list must not be misunderstood as a complete list.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.", "id": "Composition.section:sectionAditionalDocumentation.mode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.mode", "requirements": "Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.", "short": "working | snapshot | changes", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.orderedBy" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/list-order" }, "comment": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Specifies the order applied to the items in the section entries.", "id": "Composition.section:sectionAditionalDocumentation.orderedBy", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1" }, { "identity": "cda", "map": "n/a" } ], "max": "1", "min": 0, "path": "Composition.section.orderedBy", "requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.", "short": "Order of section entries", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.entry" }, "comment": "If there are no entries in the list, an emptyReason SHOULD be provided.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to the actual resource from which the narrative in the section is derived.", "id": "Composition.section:sectionAditionalDocumentation.entry", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]" }, { "identity": "cda", "map": ".entry" } ], "max": "*", "min": 1, "path": "Composition.section.entry", "short": "A reference to data that supports this section", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/DocumentReferenceOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Composition.section.emptyReason" }, "binding": { "description": "If a section is empty, why it is empty.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SectionEmptyReason" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/list-empty-reason" }, "comment": "The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.", "condition": [ "cmp-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.", "id": "Composition.section:sectionAditionalDocumentation.emptyReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]" }, { "identity": "cda", "map": "n/a" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.emptyReason", "requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.", "short": "Why the section is empty", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "Composition.section.section" }, "comment": "Nested sections are primarily used to help human readers navigate to particular portions of the document.", "condition": [ "cmp-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Composition.section", "definition": "A nested sub-section within this section.", "id": "Composition.section:sectionAditionalDocumentation.section", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]" }, { "identity": "cda", "map": ".component.section" } ], "max": "0", "min": 0, "mustSupport": false, "path": "Composition.section.section", "short": "Nested Section" } ] }, "status": "draft", "title": "OneHealth CompositionOutpatientProgressNote", "type": "Composition", "url": "https://fhir.onehealth.com.pe/StructureDefinition/CompositionOutpatientProgressNoteOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/CareTeamOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/CareTeam", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2023-10-30", "derivation": "constraint", "description": "FHIR CareTeamOH Profile, for OH interoperability scenarios, based on the national CORE CareTeam Profile defined by HL7 OH.", "differential": { "element": [ { "id": "CareTeam.identifier", "max": "1", "min": 1, "path": "CareTeam.identifier" }, { "id": "CareTeam.status", "min": 1, "path": "CareTeam.status" }, { "id": "CareTeam.category", "max": "0", "path": "CareTeam.category" }, { "id": "CareTeam.name", "min": 1, "path": "CareTeam.name" }, { "id": "CareTeam.subject", "path": "CareTeam.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/GroupOH" ] } ] }, { "id": "CareTeam.encounter", "max": "0", "path": "CareTeam.encounter" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/participant-role" }, "id": "CareTeam.participant.role", "path": "CareTeam.participant.role" }, { "id": "CareTeam.participant.role.coding.id", "max": "0", "path": "CareTeam.participant.role.coding.id" }, { "id": "CareTeam.participant.role.coding.system", "min": 1, "path": "CareTeam.participant.role.coding.system" }, { "id": "CareTeam.participant.role.coding.version", "max": "0", "path": "CareTeam.participant.role.coding.version" }, { "id": "CareTeam.participant.role.coding.code", "min": 1, "path": "CareTeam.participant.role.coding.code" }, { "id": "CareTeam.participant.role.coding.display", "min": 1, "path": "CareTeam.participant.role.coding.display" }, { "id": "CareTeam.participant.role.coding.userSelected", "max": "0", "path": "CareTeam.participant.role.coding.userSelected" }, { "id": "CareTeam.participant.role.text", "max": "0", "path": "CareTeam.participant.role.text" }, { "id": "CareTeam.participant.member", "path": "CareTeam.participant.member", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH", "https://fhir.onehealth.com.pe/StructureDefinition/CareTeamOH" ] } ] }, { "id": "CareTeam.participant.onBehalfOf", "path": "CareTeam.participant.onBehalfOf", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings" }, "id": "CareTeam.reasonCode", "path": "CareTeam.reasonCode" }, { "id": "CareTeam.reasonCode.coding.id", "max": "0", "path": "CareTeam.reasonCode.coding.id" }, { "id": "CareTeam.reasonCode.coding.system", "min": 1, "path": "CareTeam.reasonCode.coding.system" }, { "id": "CareTeam.reasonCode.coding.version", "max": "0", "path": "CareTeam.reasonCode.coding.version" }, { "id": "CareTeam.reasonCode.coding.code", "min": 1, "path": "CareTeam.reasonCode.coding.code" }, { "id": "CareTeam.reasonCode.coding.display", "min": 1, "path": "CareTeam.reasonCode.coding.display" }, { "id": "CareTeam.reasonCode.coding.userSelected", "max": "0", "path": "CareTeam.reasonCode.coding.userSelected" }, { "id": "CareTeam.reasonCode.text", "max": "0", "path": "CareTeam.reasonCode.text" }, { "id": "CareTeam.reasonReference", "max": "0", "path": "CareTeam.reasonReference" }, { "id": "CareTeam.managingOrganization", "min": 1, "path": "CareTeam.managingOrganization", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] } ] }, "fhirVersion": "4.0.1", "id": "CareTeamOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" } ], "meta": { "lastUpdated": "2024-04-12T17:46:15.363366+00:00", "versionId": "MTcxMjk0Mzk3NTM2MzM2NjAwMA" }, "name": "CareTeamOH", "publisher": "Zentricx S.A.S.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "CareTeam" }, "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.", "id": "CareTeam", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" } ], "max": "*", "min": 0, "path": "CareTeam", "short": "Planned participants in the coordination and delivery of care for a patient or group" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "CareTeam.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "CareTeam.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "CareTeam.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "CareTeam.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "CareTeam.implicitRules", "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, "max": "1", "min": 0, "path": "CareTeam.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "CareTeam.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "CareTeam.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "CareTeam.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "CareTeam.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "CareTeam.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "CareTeam.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CareTeam.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "CareTeam.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "CareTeam.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "CareTeam.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CareTeam.identifier" }, "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 a Person resource instance might share the same social insurance number.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", "id": "CareTeam.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" } ], "max": "1", "min": 1, "path": "CareTeam.identifier", "requirements": "Allows identification of the care team as it is known by various participating systems and in a way that remains consistent across servers.", "short": "External Ids for this team", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "CareTeam.status" }, "binding": { "description": "Indicates the status of the care team.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CareTeamStatus" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/care-team-status|4.0.1" }, "comment": "This element is labeled as a modifier because the status contains the code entered-in-error that marks the care team as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the current state of the care team.", "id": "CareTeam.status", "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, "mapping": [ { "identity": "w5", "map": "FiveWs.status" } ], "max": "1", "min": 1, "path": "CareTeam.status", "short": "proposed | active | suspended | inactive | entered-in-error", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "CareTeam.category" }, "binding": { "description": "Indicates the type of care team.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CareTeamCategory" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/care-team-category" }, "comment": "There may be multiple axis of categorization and one team may serve multiple purposes.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.", "id": "CareTeam.category", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" } ], "max": "0", "min": 0, "path": "CareTeam.category", "requirements": "Used for filtering what teams(s) are retrieved and displayed to different types of users.", "short": "Type of team", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "CareTeam.name" }, "comment": "The meaning/purpose of the team is conveyed in CareTeam.category. This element may also convey semantics of the team (e.g. \"Red trauma team\"), but its primary purpose is to distinguish between identical teams in a human-friendly way. (\"Team 18735\" isn't as friendly.).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A label for human use intended to distinguish like teams. E.g. the \"red\" vs. \"green\" trauma teams.", "id": "CareTeam.name", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "CareTeam.name", "short": "Name of the team, such as crisis assessment team", "type": [ { "code": "string" } ] }, { "alias": [ "patient" ], "base": { "max": "1", "min": 0, "path": "CareTeam.subject" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the patient or group whose intended care is handled by the team.", "id": "CareTeam.subject", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 0, "path": "CareTeam.subject", "requirements": "Allows the team to care for a group (e.g. marriage) therapy. \nAllows for an organization to designate a team such as the PICC line team.", "short": "Who care team is for", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH", "https://fhir.onehealth.com.pe/StructureDefinition/GroupOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "CareTeam.encounter" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.", "id": "CareTeam.encounter", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.context" } ], "max": "0", "min": 0, "path": "CareTeam.encounter", "short": "Encounter created as part of", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ] } ] }, { "base": { "max": "1", "min": 0, "path": "CareTeam.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates when the team did (or is intended to) come into effect and end.", "id": "CareTeam.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.init" } ], "max": "1", "min": 0, "path": "CareTeam.period", "requirements": "Allows tracking what team(s) are in effect at a particular time.", "short": "Time period team covers", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "CareTeam.participant" }, "condition": [ "ctm-1" ], "constraint": [ { "expression": "onBehalfOf.exists() implies (member.resolve().iif(empty(), true, ofType(Practitioner).exists()))", "human": "CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner", "key": "ctm-1", "severity": "error", "xpath": "starts-with(f:member/f:reference/@value, 'Practitioner/') or contains(f:member/f:reference/@value, '/Practitioner/') or exists(ancestor::*/f:contains/f:Practitioner/f:id[@value=substring-after(current()/f:member/f:reference/@value, '#')]) or not(exists(f:onBehalfOf))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies all people and organizations who are expected to be involved in the care team.", "id": "CareTeam.participant", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "REL (REL.4 is always the Patient) ( or PRT?)" }, { "identity": "rim", "map": ".participation[typeCode=PRF]" } ], "max": "*", "min": 0, "path": "CareTeam.participant", "short": "Members of the team", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CareTeam.participant.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "CareTeam.participant.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CareTeam.participant.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CareTeam.participant.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "CareTeam.participant.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "CareTeam.participant.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CareTeam.participant.role" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/participant-role" }, "comment": "Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care team. General relationships should be handled as properties of the Patient resource directly.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates specific responsibility of an individual within the care team, such as \"Primary care physician\", \"Trained social worker counselor\", \"Caregiver\", etc.", "id": "CareTeam.participant.role", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "REL.2 (or PRT-4?)" }, { "identity": "rim", "map": ".functionCode" } ], "max": "*", "min": 0, "path": "CareTeam.participant.role", "short": "Type of involvement", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CareTeam.participant.role.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "CareTeam.participant.role.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CareTeam.participant.role.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CareTeam.participant.role.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "CareTeam.participant.role.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "CareTeam.participant.role.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CareTeam.participant.role.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "CareTeam.participant.role.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CareTeam.participant.role.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CareTeam.participant.role.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "CareTeam.participant.role.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "CareTeam.participant.role.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "CareTeam.participant.role.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "CareTeam.participant.role.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "CareTeam.participant.role.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "CareTeam.participant.role.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "CareTeam.participant.role.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "CareTeam.participant.role.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "CareTeam.participant.role.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "CareTeam.participant.role.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "CareTeam.participant.role.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "CareTeam.participant.role.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "CareTeam.participant.member" }, "comment": "Patient only needs to be listed if they have a role other than \"subject of care\".\n\nMember is optional because some participants may be known only by their role, particularly in draft plans.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The specific person or organization who is participating/expected to participate in the care team.", "id": "CareTeam.participant.member", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "v2", "map": "REL.5 (or PRT-5 : ( PRV-4 {provider participations} ) / PRT-5 : ( PRV-4 {non-provider person participations} ) / PRT-5 : ( PRV-4 = (patient non-subject of care) ) / PRT-8?)" }, { "identity": "rim", "map": ".role" } ], "max": "1", "min": 0, "path": "CareTeam.participant.member", "short": "Who is involved", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH", "https://fhir.onehealth.com.pe/StructureDefinition/CareTeamOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "CareTeam.participant.onBehalfOf" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The organization of the practitioner.", "id": "CareTeam.participant.onBehalfOf", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "CareTeam.participant.onBehalfOf", "requirements": "Practitioners can be associated with multiple organizations. This element indicates which organization they were acting on behalf of.", "short": "Organization of the practitioner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "CareTeam.participant.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates when the specific member or organization did (or is intended to) come into effect and end.", "id": "CareTeam.participant.period", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "CareTeam.participant.period", "short": "Time period of participant", "type": [ { "code": "Period" } ] }, { "base": { "max": "*", "min": 0, "path": "CareTeam.reasonCode" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes why the care team exists.", "id": "CareTeam.reasonCode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.why[x]" } ], "max": "*", "min": 0, "path": "CareTeam.reasonCode", "short": "Why the care team exists", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CareTeam.reasonCode.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "CareTeam.reasonCode.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CareTeam.reasonCode.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CareTeam.reasonCode.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "CareTeam.reasonCode.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "CareTeam.reasonCode.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CareTeam.reasonCode.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "CareTeam.reasonCode.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CareTeam.reasonCode.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CareTeam.reasonCode.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "CareTeam.reasonCode.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "CareTeam.reasonCode.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "CareTeam.reasonCode.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "CareTeam.reasonCode.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "CareTeam.reasonCode.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "CareTeam.reasonCode.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "CareTeam.reasonCode.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "CareTeam.reasonCode.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "CareTeam.reasonCode.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "CareTeam.reasonCode.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "CareTeam.reasonCode.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "CareTeam.reasonCode.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "CareTeam.reasonReference" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Condition(s) that this care team addresses.", "id": "CareTeam.reasonReference", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.why[x]" } ], "max": "0", "min": 0, "path": "CareTeam.reasonReference", "short": "Why the care team exists", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CareTeam.managingOrganization" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The organization responsible for the care team.", "id": "CareTeam.managingOrganization", "isModifier": false, "isSummary": true, "max": "*", "min": 1, "path": "CareTeam.managingOrganization", "requirements": "Allows for multiple organizations to collaboratively manage cross-organizational, longitudinal care plan.", "short": "Organization responsible for the care team", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CareTeam.telecom" }, "comment": "The ContactPoint.use code of home is not appropriate to use. These contacts are not the contact details of individual care team members.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A central contact detail for the care team (that applies to all members).", "id": "CareTeam.telecom", "isModifier": false, "isSummary": false, "max": "*", "min": 0, "path": "CareTeam.telecom", "short": "A contact detail for the care team (that applies to all members)", "type": [ { "code": "ContactPoint" } ] }, { "base": { "max": "*", "min": 0, "path": "CareTeam.note" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Comments made about the CareTeam.", "id": "CareTeam.note", "isModifier": false, "isSummary": false, "max": "*", "min": 0, "path": "CareTeam.note", "short": "Comments made about the CareTeam", "type": [ { "code": "Annotation" } ] } ] }, "status": "draft", "title": "OneHealth CareTeam", "type": "CareTeam", "url": "https://fhir.onehealth.com.pe/StructureDefinition/CareTeamOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/CarePlanOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/CarePlan", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Mario Cortés", "telecom": [ { "system": "email", "use": "work", "value": "mario.cortes@hl7co.org" } ] } ], "copyright": "Zentricx 2024+", "date": "2024-03-08", "derivation": "constraint", "description": "FHIR Account Profile, for OH interoperability scenarios, based on the national CORE CarePlan Profile defined by HL7 OH.", "differential": { "element": [ { "id": "CarePlan", "path": "CarePlan", "short": "OneHealth CarePlan" }, { "definition": "Identification of the OneHealth care plan assigned by Rimac.", "id": "CarePlan.identifier", "label": "Identificación del plan", "max": "1", "min": 1, "path": "CarePlan.identifier", "short": "OneHealth Care Plan Identifier" }, { "fixedCode": "usual", "id": "CarePlan.identifier.use", "path": "CarePlan.identifier.use" }, { "id": "CarePlan.identifier.type", "max": "0", "path": "CarePlan.identifier.type" }, { "fixedUri": "https://fhir.onehealth.com.pe/NamingSystem/CarePlans", "id": "CarePlan.identifier.system", "path": "CarePlan.identifier.system" }, { "definition": "Value of the OneHealth care plan identifier assigned by Rimac.", "id": "CarePlan.identifier.value", "label": "Identificador de plan de cuidado", "min": 1, "path": "CarePlan.identifier.value", "short": "Value of care plan identification" }, { "id": "CarePlan.identifier.assigner", "path": "CarePlan.identifier.assigner", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "CarePlan.instantiatesCanonical", "max": "1", "path": "CarePlan.instantiatesCanonical", "type": [ { "code": "canonical", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PlanDefinitionOH" ] } ] }, { "definition": "The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan (This might be an HTML page, PDF, etc.).", "id": "CarePlan.instantiatesUri", "label": "URL Protocolo", "max": "1", "path": "CarePlan.instantiatesUri" }, { "id": "CarePlan.basedOn", "max": "0", "path": "CarePlan.basedOn" }, { "id": "CarePlan.replaces", "path": "CarePlan.replaces", "type": [ { "code": "Reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", "valueBoolean": true } ], "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/CarePlanOH" ] } ] }, { "id": "CarePlan.partOf", "max": "0", "path": "CarePlan.partOf" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-status|4.0.1" }, "id": "CarePlan.status", "label": "Estatus", "path": "CarePlan.status" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1" }, "fixedCode": "plan", "id": "CarePlan.intent", "path": "CarePlan.intent" }, { "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/careplancategoryOH" }, "definition": "Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Young Moms\", \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", \"wellness plan\", etc.", "id": "CarePlan.category", "label": "Categoría", "max": "1", "path": "CarePlan.category", "short": "Type of care plan" }, { "id": "CarePlan.category.coding.id", "max": "0", "path": "CarePlan.category.coding.id" }, { "id": "CarePlan.category.coding.system", "min": 1, "path": "CarePlan.category.coding.system" }, { "id": "CarePlan.category.coding.version", "max": "0", "path": "CarePlan.category.coding.version" }, { "id": "CarePlan.category.coding.code", "min": 1, "path": "CarePlan.category.coding.code" }, { "id": "CarePlan.category.coding.display", "min": 1, "path": "CarePlan.category.coding.display" }, { "id": "CarePlan.category.coding.userSelected", "max": "0", "path": "CarePlan.category.coding.userSelected" }, { "id": "CarePlan.category.text", "max": "0", "path": "CarePlan.category.text" }, { "id": "CarePlan.title", "label": "Título", "min": 1, "path": "CarePlan.title" }, { "id": "CarePlan.description", "label": "Descripción", "path": "CarePlan.description" }, { "id": "CarePlan.subject", "label": "Paciente", "path": "CarePlan.subject", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "CarePlan.encounter", "path": "CarePlan.encounter", "short": "Encounter associated with the care plan", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "id": "CarePlan.period.start", "min": 1, "path": "CarePlan.period.start", "short": "Date of end of care plan" }, { "id": "CarePlan.author", "path": "CarePlan.author", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH" ] } ] }, { "id": "CarePlan.contributor", "path": "CarePlan.contributor", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH", "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH", "https://fhir.onehealth.com.pe/StructureDefinition/CareTeamOH" ] } ] }, { "id": "CarePlan.careTeam", "path": "CarePlan.careTeam", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/CareTeamOH" ] } ] }, { "id": "CarePlan.addresses", "min": 1, "path": "CarePlan.addresses", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH", "https://fhir.onehealth.com.pe/StructureDefinition/ConditionProblemListItemOH" ] } ] }, { "id": "CarePlan.supportingInfo", "path": "CarePlan.supportingInfo", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/DocumentReferenceOH" ] } ] }, { "id": "CarePlan.goal", "path": "CarePlan.goal", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/GoalOH" ] } ] }, { "id": "CarePlan.activity", "min": 1, "path": "CarePlan.activity" }, { "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/careplanactivityoutcomeOH" }, "id": "CarePlan.activity.outcomeCodeableConcept", "max": "1", "path": "CarePlan.activity.outcomeCodeableConcept" }, { "id": "CarePlan.activity.outcomeCodeableConcept.coding.id", "max": "0", "path": "CarePlan.activity.outcomeCodeableConcept.coding.id" }, { "id": "CarePlan.activity.outcomeCodeableConcept.coding.system", "min": 1, "path": "CarePlan.activity.outcomeCodeableConcept.coding.system" }, { "id": "CarePlan.activity.outcomeCodeableConcept.coding.version", "max": "0", "path": "CarePlan.activity.outcomeCodeableConcept.coding.version" }, { "id": "CarePlan.activity.outcomeCodeableConcept.coding.code", "min": 1, "path": "CarePlan.activity.outcomeCodeableConcept.coding.code" }, { "id": "CarePlan.activity.outcomeCodeableConcept.coding.display", "min": 1, "path": "CarePlan.activity.outcomeCodeableConcept.coding.display" }, { "id": "CarePlan.activity.outcomeCodeableConcept.coding.userSelected", "max": "0", "path": "CarePlan.activity.outcomeCodeableConcept.coding.userSelected" }, { "id": "CarePlan.activity.outcomeCodeableConcept.text", "max": "0", "path": "CarePlan.activity.outcomeCodeableConcept.text" }, { "id": "CarePlan.activity.outcomeReference", "max": "0", "path": "CarePlan.activity.outcomeReference" }, { "id": "CarePlan.activity.reference", "max": "0", "path": "CarePlan.activity.reference" }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1" }, "fixedCode": "Task", "id": "CarePlan.activity.detail.kind", "min": 1, "path": "CarePlan.activity.detail.kind" }, { "id": "CarePlan.activity.detail.instantiatesCanonical", "max": "0", "path": "CarePlan.activity.detail.instantiatesCanonical" }, { "id": "CarePlan.activity.detail.instantiatesUri", "max": "0", "path": "CarePlan.activity.detail.instantiatesUri" }, { "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/careplanactivitycodeOH" }, "id": "CarePlan.activity.detail.code", "min": 1, "path": "CarePlan.activity.detail.code" }, { "id": "CarePlan.activity.detail.code.coding.id", "max": "0", "path": "CarePlan.activity.detail.code.coding.id" }, { "id": "CarePlan.activity.detail.code.coding.system", "min": 1, "path": "CarePlan.activity.detail.code.coding.system" }, { "id": "CarePlan.activity.detail.code.coding.version", "max": "0", "path": "CarePlan.activity.detail.code.coding.version" }, { "id": "CarePlan.activity.detail.code.coding.code", "min": 1, "path": "CarePlan.activity.detail.code.coding.code" }, { "id": "CarePlan.activity.detail.code.coding.display", "min": 1, "path": "CarePlan.activity.detail.code.coding.display" }, { "id": "CarePlan.activity.detail.code.coding.userSelected", "max": "0", "path": "CarePlan.activity.detail.code.coding.userSelected" }, { "id": "CarePlan.activity.detail.code.text", "path": "CarePlan.activity.detail.code.text", "short": "Textual description for activity" }, { "id": "CarePlan.activity.detail.reasonCode", "max": "0", "path": "CarePlan.activity.detail.reasonCode" }, { "id": "CarePlan.activity.detail.reasonReference", "max": "0", "path": "CarePlan.activity.detail.reasonReference" }, { "id": "CarePlan.activity.detail.goal", "path": "CarePlan.activity.detail.goal", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/GoalOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1" }, "id": "CarePlan.activity.detail.status", "path": "CarePlan.activity.detail.status" }, { "id": "CarePlan.activity.detail.statusReason", "max": "0", "path": "CarePlan.activity.detail.statusReason" }, { "id": "CarePlan.activity.detail.doNotPerform", "max": "0", "path": "CarePlan.activity.detail.doNotPerform" }, { "definition": "The period upon which the described activity is to occur.", "id": "CarePlan.activity.detail.scheduled[x]", "path": "CarePlan.activity.detail.scheduled[x]", "type": [ { "code": "Period" } ] }, { "id": "CarePlan.activity.detail.scheduled[x].start", "min": 1, "path": "CarePlan.activity.detail.scheduled[x].start" }, { "id": "CarePlan.activity.detail.scheduled[x].end", "min": 1, "path": "CarePlan.activity.detail.scheduled[x].end" }, { "id": "CarePlan.activity.detail.location", "path": "CarePlan.activity.detail.location", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/LocationOH" ] } ] }, { "id": "CarePlan.activity.detail.performer", "path": "CarePlan.activity.detail.performer", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH", "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH", "https://fhir.onehealth.com.pe/StructureDefinition/CareTeamOH", "https://fhir.onehealth.com.pe/StructureDefinition/HealthcareServiceOH" ] } ] }, { "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/medication-codes" }, "id": "CarePlan.activity.detail.product[x]", "path": "CarePlan.activity.detail.product[x]", "type": [ { "code": "CodeableConcept" } ] }, { "id": "CarePlan.activity.detail.product[x].coding.id", "max": "0", "path": "CarePlan.activity.detail.product[x].coding.id" }, { "id": "CarePlan.activity.detail.product[x].coding.system", "min": 1, "path": "CarePlan.activity.detail.product[x].coding.system" }, { "id": "CarePlan.activity.detail.product[x].coding.version", "max": "0", "path": "CarePlan.activity.detail.product[x].coding.version" }, { "id": "CarePlan.activity.detail.product[x].coding.code", "min": 1, "path": "CarePlan.activity.detail.product[x].coding.code" }, { "id": "CarePlan.activity.detail.product[x].coding.display", "min": 1, "path": "CarePlan.activity.detail.product[x].coding.display" }, { "id": "CarePlan.activity.detail.product[x].coding.userSelected", "max": "0", "path": "CarePlan.activity.detail.product[x].coding.userSelected" }, { "id": "CarePlan.activity.detail.product[x].text", "max": "0", "path": "CarePlan.activity.detail.product[x].text" }, { "id": "CarePlan.activity.detail.dailyAmount", "max": "0", "path": "CarePlan.activity.detail.dailyAmount" }, { "id": "CarePlan.activity.detail.quantity", "max": "0", "path": "CarePlan.activity.detail.quantity" } ] }, "fhirVersion": "4.0.1", "id": "CarePlanOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "workflow", "name": "Workflow Pattern", "uri": "http://hl7.org/fhir/workflow" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" }, { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" } ], "meta": { "lastUpdated": "2024-04-12T17:46:15.108856+00:00", "versionId": "MTcxMjk0Mzk3NTEwODg1NjAwMA" }, "name": "AccountOH", "publisher": "Zentricx S.A.S.", "purpose": "Recording and tracking information from a plan of care that has been prescribed for a patient.", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "alias": [ "Care Team" ], "base": { "max": "*", "min": 0, "path": "CarePlan" }, "constraint": [ { "expression": "contained.contained.empty()", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "key": "dom-2", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(parent::f:contained and f:contained)" }, { "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()", "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", "key": "dom-3", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "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='#'])]))" }, { "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "key": "dom-4", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "expression": "contained.meta.security.empty()", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "key": "dom-5", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "not(exists(f:contained/*/f:meta/f:security))" }, { "expression": "text.`div`.exists()", "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." } ], "human": "A resource should have narrative for robust management", "key": "dom-6", "severity": "warning", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "xpath": "exists(f:text/h:div)" } ], "definition": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.", "id": "CarePlan", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Request" }, { "identity": "rim", "map": "Act[classCode=PCPR, moodCode=INT]" } ], "max": "*", "min": 0, "path": "CarePlan", "short": "OneHealth CarePlan" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "CarePlan.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "CarePlan.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "CarePlan.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "CarePlan.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "CarePlan.implicitRules", "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, "max": "1", "min": 0, "path": "CarePlan.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "CarePlan.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "CarePlan.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "alias": [ "narrative", "html", "xhtml", "display" ], "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "CarePlan.text", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ], "max": "1", "min": 0, "path": "CarePlan.text", "short": "Text summary of the resource, for human interpretation", "type": [ { "code": "Narrative" } ] }, { "alias": [ "inline resources", "anonymous resources", "contained resources" ], "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "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.", "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.", "id": "CarePlan.contained", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "CarePlan.contained", "short": "Contained, inline Resources", "type": [ { "code": "Resource" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CarePlan.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ], "max": "*", "min": 0, "path": "CarePlan.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "CarePlan.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "CarePlan.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.identifier" }, "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 a Person resource instance might share the same social insurance number.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identification of the OneHealth care plan assigned by Rimac.", "id": "CarePlan.identifier", "isModifier": false, "isSummary": true, "label": "Identificación del plan", "mapping": [ { "identity": "workflow", "map": "Request.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "PTH-3" }, { "identity": "rim", "map": ".id" } ], "max": "1", "min": 1, "path": "CarePlan.identifier", "requirements": "Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers.", "short": "OneHealth Care Plan Identifier", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CarePlan.identifier.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "CarePlan.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CarePlan.identifier.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CarePlan.identifier.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "binding": { "description": "Identifies the purpose for this identifier, if known .", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" }, "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The purpose of this identifier.", "fixedCode": "usual", "id": "CarePlan.identifier.use", "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "1", "min": 0, "path": "CarePlan.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "short": "usual | official | temp | secondary | old (If known)", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "binding": { "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "id": "CarePlan.identifier.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ], "max": "0", "min": 0, "path": "CarePlan.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "short": "Description of identifier", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "comment": "Identifier.system is always case sensitive.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "fixedUri": "https://fhir.onehealth.com.pe/NamingSystem/CarePlans", "id": "CarePlan.identifier.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ], "max": "1", "min": 0, "path": "CarePlan.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "short": "The namespace for the identifier value", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Value of the OneHealth care plan identifier assigned by Rimac.", "example": [ { "label": "General", "valueString": "123456" } ], "id": "CarePlan.identifier.value", "isModifier": false, "isSummary": true, "label": "Identificador de plan de cuidado", "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ], "max": "1", "min": 1, "path": "CarePlan.identifier.value", "short": "Value of care plan identification", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Time period during which identifier is/was valid for use.", "id": "CarePlan.identifier.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ], "max": "1", "min": 0, "path": "CarePlan.identifier.period", "short": "Time period when id is/was valid for use", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Organization that issued/manages the identifier.", "id": "CarePlan.identifier.assigner", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ], "max": "1", "min": 0, "path": "CarePlan.identifier.assigner", "short": "Organization that issued id (may be just text)", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.instantiatesCanonical" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.", "id": "CarePlan.instantiatesCanonical", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.instantiatesCanonical" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ], "max": "1", "min": 0, "path": "CarePlan.instantiatesCanonical", "short": "Instantiates FHIR protocol or definition", "type": [ { "code": "canonical", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PlanDefinitionOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.instantiatesUri" }, "comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan (This might be an HTML page, PDF, etc.).", "id": "CarePlan.instantiatesUri", "isModifier": false, "isSummary": true, "label": "URL Protocolo", "mapping": [ { "identity": "workflow", "map": "Request.instantiatesUri" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ], "max": "1", "min": 0, "path": "CarePlan.instantiatesUri", "short": "Instantiates external protocol or definition", "type": [ { "code": "uri" } ] }, { "alias": [ "fulfills" ], "base": { "max": "*", "min": 0, "path": "CarePlan.basedOn" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A care plan that is fulfilled in whole or in part by this care plan.", "id": "CarePlan.basedOn", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.basedOn" } ], "max": "0", "min": 0, "path": "CarePlan.basedOn", "requirements": "Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.", "short": "Fulfills CarePlan", "type": [ { "code": "Reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", "valueBoolean": true } ], "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CarePlan" ] } ] }, { "alias": [ "supersedes" ], "base": { "max": "*", "min": 0, "path": "CarePlan.replaces" }, "comment": "The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Completed or terminated care plan whose function is taken by this new care plan.", "id": "CarePlan.replaces", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.replaces" } ], "max": "*", "min": 0, "path": "CarePlan.replaces", "requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.", "short": "CarePlan replaced by this CarePlan", "type": [ { "code": "Reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", "valueBoolean": true } ], "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/CarePlanOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.partOf" }, "comment": "Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A larger care plan of which this particular care plan is a component or step.", "id": "CarePlan.partOf", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "CarePlan.partOf", "short": "Part of referenced CarePlan", "type": [ { "code": "Reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy", "valueBoolean": true } ], "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CarePlan" ] } ] }, { "base": { "max": "1", "min": 1, "path": "CarePlan.status" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/request-status|4.0.1" }, "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 care plan.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.", "id": "CarePlan.status", "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, "label": "Estatus", "mapping": [ { "identity": "workflow", "map": "Request.status {uses different ValueSet}" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "v2", "map": "PTH-5" }, { "identity": "rim", "map": ".statusCode planned = new active = active completed = completed" } ], "max": "1", "min": 1, "path": "CarePlan.status", "requirements": "Allows clinicians to determine whether the plan is actionable or not.", "short": "draft | active | on-hold | revoked | completed | entered-in-error | unknown", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "CarePlan.intent" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1" }, "comment": "This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.", "fixedCode": "plan", "id": "CarePlan.intent", "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, "mapping": [ { "identity": "workflow", "map": "Request.intent" } ], "max": "1", "min": 1, "path": "CarePlan.intent", "requirements": "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.", "short": "proposal | plan | order | option", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.category" }, "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/careplancategoryOH" }, "comment": "There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Young Moms\", \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", \"wellness plan\", etc.", "id": "CarePlan.category", "isModifier": false, "isSummary": true, "label": "Categoría", "mapping": [ { "identity": "w5", "map": "FiveWs.class" } ], "max": "1", "min": 0, "path": "CarePlan.category", "requirements": "Used for filtering what plan(s) are retrieved and displayed to different types of users.", "short": "Type of care plan", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CarePlan.category.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "CarePlan.category.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CarePlan.category.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CarePlan.category.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "CarePlan.category.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "CarePlan.category.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CarePlan.category.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "CarePlan.category.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CarePlan.category.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CarePlan.category.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "CarePlan.category.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "CarePlan.category.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "CarePlan.category.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "CarePlan.category.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "CarePlan.category.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "CarePlan.category.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "CarePlan.category.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "CarePlan.category.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "CarePlan.category.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "CarePlan.category.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "CarePlan.category.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "CarePlan.category.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.title" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Human-friendly name for the care plan.", "id": "CarePlan.title", "isModifier": false, "isSummary": true, "label": "Título", "max": "1", "min": 1, "path": "CarePlan.title", "short": "Human-friendly name for the care plan", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.description" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A description of the scope and nature of the plan.", "id": "CarePlan.description", "isModifier": false, "isSummary": true, "label": "Descripción", "mapping": [ { "identity": "w5", "map": "FiveWs.what[x]" } ], "max": "1", "min": 0, "path": "CarePlan.description", "requirements": "Provides more detail than conveyed by category.", "short": "Summary of nature of plan", "type": [ { "code": "string" } ] }, { "alias": [ "patient" ], "base": { "max": "1", "min": 1, "path": "CarePlan.subject" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the patient or group whose intended care is described by the plan.", "id": "CarePlan.subject", "isModifier": false, "isSummary": true, "label": "Paciente", "mapping": [ { "identity": "workflow", "map": "Request.subject" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": ".participation[typeCode=PAT].role[classCode=PAT]" }, { "identity": "w5", "map": "FiveWs.subject" } ], "max": "1", "min": 1, "path": "CarePlan.subject", "short": "Who the care plan is for", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.encounter" }, "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. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.", "id": "CarePlan.encounter", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.context" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "v2", "map": "Associated PV1" }, { "identity": "rim", "map": "." } ], "max": "1", "min": 0, "path": "CarePlan.encounter", "short": "Encounter associated with the care plan", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "alias": [ "timing" ], "base": { "max": "1", "min": 0, "path": "CarePlan.period" }, "comment": "Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates when the plan did (or is intended to) come into effect and end.", "id": "CarePlan.period", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.planned" }, { "identity": "v2", "map": "GOL-7 / GOL-8" }, { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 0, "path": "CarePlan.period", "requirements": "Allows tracking what plan(s) are in effect at a particular time.", "short": "Time period plan covers", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CarePlan.period.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "CarePlan.period.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CarePlan.period.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CarePlan.period.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.start" }, "comment": "If the low element is missing, the meaning is that the low boundary is not known.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The start of the period. The boundary is inclusive.", "id": "CarePlan.period.start", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ], "max": "1", "min": 1, "path": "CarePlan.period.start", "short": "Date of end of care plan", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.end" }, "comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "id": "CarePlan.period.end", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ], "max": "1", "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "min": 0, "path": "CarePlan.period.end", "short": "End time with inclusive boundary, if not ongoing", "type": [ { "code": "dateTime" } ] }, { "alias": [ "authoredOn" ], "base": { "max": "1", "min": 0, "path": "CarePlan.created" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Represents when this particular CarePlan record was created in the system, which is often a system-generated date.", "id": "CarePlan.created", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.authoredOn" }, { "identity": "w5", "map": "FiveWs.recorded" }, { "identity": "rim", "map": ".participation[typeCode=AUT].time" } ], "max": "1", "min": 0, "path": "CarePlan.created", "short": "Date record was first recorded", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.author" }, "comment": "The author may also be a contributor. For example, an organization can be an author, but not listed as a contributor.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When populated, the author is responsible for the care plan. The care plan is attributed to the author.", "id": "CarePlan.author", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.requester" }, { "identity": "w5", "map": "FiveWs.author" } ], "max": "1", "min": 0, "path": "CarePlan.author", "short": "Who is the designated responsible party", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.contributor" }, "comment": "Collaborative care plans may have multiple contributors.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the individual(s) or organization who provided the contents of the care plan.", "id": "CarePlan.contributor", "isModifier": false, "isSummary": false, "max": "*", "min": 0, "path": "CarePlan.contributor", "short": "Who provided the content of the care plan", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH", "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH", "https://fhir.onehealth.com.pe/StructureDefinition/CareTeamOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.careTeam" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.", "id": "CarePlan.careTeam", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.performer {similar but does not entail CareTeam}" }, { "identity": "w5", "map": "FiveWs.actor" } ], "max": "*", "min": 0, "path": "CarePlan.careTeam", "requirements": "Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.", "short": "Who's involved in plan?", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/CareTeamOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.addresses" }, "comment": "When the diagnosis is related to an allergy or intolerance, the Condition and AllergyIntolerance resources can both be used. However, to be actionable for decision support, using Condition alone is not sufficient as the allergy or intolerance condition needs to be represented as an AllergyIntolerance.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.", "id": "CarePlan.addresses", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.reasonReference" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "v2", "map": "PRB-4" }, { "identity": "rim", "map": ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]" } ], "max": "*", "min": 1, "path": "CarePlan.addresses", "requirements": "Links plan to the conditions it manages. The element can identify risks addressed by the plan as well as active conditions. (The Condition resource can include things like \"at risk for hypertension\" or \"fall risk\".) Also scopes plans - multiple plans may exist addressing different concerns.", "short": "Health issues this plan addresses", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH", "https://fhir.onehealth.com.pe/StructureDefinition/ConditionProblemListItemOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.supportingInfo" }, "comment": "Use \"concern\" to identify specific conditions addressed by the care plan.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.", "id": "CarePlan.supportingInfo", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.supportingInfo" } ], "max": "*", "min": 0, "path": "CarePlan.supportingInfo", "requirements": "Identifies barriers and other considerations associated with the care plan.", "short": "Information considered as part of plan", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/DocumentReferenceOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.goal" }, "comment": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Describes the intended objective(s) of carrying out the care plan.", "id": "CarePlan.goal", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "GOL.1" }, { "identity": "rim", "map": ".outboundRelationship[typeCode<=OBJ]." } ], "max": "*", "min": 0, "path": "CarePlan.goal", "requirements": "Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.", "short": "Desired outcome of plan", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/GoalOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.activity" }, "constraint": [ { "expression": "detail.empty() or reference.empty()", "human": "Provide a reference or detail, not both", "key": "cpl-3", "severity": "error", "xpath": "not(exists(f:detail)) or not(exists(f:reference))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.", "id": "CarePlan.activity", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "{no mapping\nNOTE: This is a list of contained Request-Event tuples!}" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target" } ], "max": "*", "min": 1, "path": "CarePlan.activity", "requirements": "Allows systems to prompt for performance of planned activities, and validate plans against best practice.", "short": "Action to occur as part of plan", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CarePlan.activity.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "CarePlan.activity.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CarePlan.activity.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CarePlan.activity.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "CarePlan.activity.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "CarePlan.activity.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.activity.outcomeCodeableConcept" }, "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/careplanactivityoutcomeOH" }, "comment": "Note that this should not duplicate the activity status (e.g. completed or in progress).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).", "id": "CarePlan.activity.outcomeCodeableConcept", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "CarePlan.activity.outcomeCodeableConcept", "short": "Results of the activity", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CarePlan.activity.outcomeCodeableConcept.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "CarePlan.activity.outcomeCodeableConcept.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CarePlan.activity.outcomeCodeableConcept.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CarePlan.activity.outcomeCodeableConcept.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "CarePlan.activity.outcomeCodeableConcept.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "CarePlan.activity.outcomeCodeableConcept.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CarePlan.activity.outcomeCodeableConcept.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "CarePlan.activity.outcomeCodeableConcept.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CarePlan.activity.outcomeCodeableConcept.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CarePlan.activity.outcomeCodeableConcept.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "CarePlan.activity.outcomeCodeableConcept.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "CarePlan.activity.outcomeCodeableConcept.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "CarePlan.activity.outcomeCodeableConcept.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "CarePlan.activity.outcomeCodeableConcept.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "CarePlan.activity.outcomeCodeableConcept.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "CarePlan.activity.outcomeCodeableConcept.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "CarePlan.activity.outcomeCodeableConcept.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "CarePlan.activity.outcomeCodeableConcept.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "CarePlan.activity.outcomeCodeableConcept.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "CarePlan.activity.outcomeCodeableConcept.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "CarePlan.activity.outcomeCodeableConcept.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "CarePlan.activity.outcomeCodeableConcept.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.activity.outcomeReference" }, "comment": "The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Details of the outcome or action resulting from the activity. The reference to an \"event\" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).", "id": "CarePlan.activity.outcomeReference", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "{Event that is outcome of Request in activity.reference}" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=FLFS].source" } ], "max": "0", "min": 0, "path": "CarePlan.activity.outcomeReference", "requirements": "Links plan to resulting actions.", "short": "Appointment, Encounter, Procedure, etc.", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.activity.progress" }, "comment": "This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Notes about the adherence/status/progress of the activity.", "id": "CarePlan.activity.progress", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "NTE?" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" } ], "max": "*", "min": 0, "path": "CarePlan.activity.progress", "requirements": "Can be used to capture information about adherence, progress, concerns, etc.", "short": "Comments about the activity status/progress", "type": [ { "code": "Annotation" } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.activity.reference" }, "comment": "Standard extension exists ([resource-pertainsToGoal](extension-resource-pertainstogoal.html)) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference. \rThe goal should be visible when the resource referenced by CarePlan.activity.reference is viewed independently from the CarePlan. Requests that are pointed to by a CarePlan using this element should *not* point to this CarePlan using the \"basedOn\" element. i.e. Requests that are part of a CarePlan are not \"based on\" the CarePlan.", "condition": [ "cpl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The details of the proposed activity represented in a specific resource.", "id": "CarePlan.activity.reference", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "{Request that resulted in Event in activity.actionResulting}" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target" } ], "max": "0", "min": 0, "path": "CarePlan.activity.reference", "requirements": "Details in a form consistent with other applications and contexts of use.", "short": "Activity details defined in specific resource", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Appointment", "http://hl7.org/fhir/StructureDefinition/CommunicationRequest", "http://hl7.org/fhir/StructureDefinition/DeviceRequest", "http://hl7.org/fhir/StructureDefinition/MedicationRequest", "http://hl7.org/fhir/StructureDefinition/NutritionOrder", "http://hl7.org/fhir/StructureDefinition/Task", "http://hl7.org/fhir/StructureDefinition/ServiceRequest", "http://hl7.org/fhir/StructureDefinition/VisionPrescription", "http://hl7.org/fhir/StructureDefinition/RequestGroup" ] } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.activity.detail" }, "condition": [ "cpl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.", "id": "CarePlan.activity.detail", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target" } ], "max": "1", "min": 0, "path": "CarePlan.activity.detail", "requirements": "Details in a simple form for generic care plan systems.", "short": "In-line definition of activity", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CarePlan.activity.detail.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "CarePlan.activity.detail.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CarePlan.activity.detail.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CarePlan.activity.detail.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "CarePlan.activity.detail.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "CarePlan.activity.detail.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.activity.detail.kind" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.", "fixedCode": "Task", "id": "CarePlan.activity.detail.kind", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=LIST].code" } ], "max": "1", "min": 1, "path": "CarePlan.activity.detail.kind", "requirements": "May determine what types of extensions are permitted.", "short": "Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription", "type": [ { "code": "code" } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.activity.detail.instantiatesCanonical" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.", "id": "CarePlan.activity.detail.instantiatesCanonical", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.instantiatesCanonical" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ], "max": "0", "min": 0, "path": "CarePlan.activity.detail.instantiatesCanonical", "requirements": "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.", "short": "Instantiates FHIR protocol or definition", "type": [ { "code": "canonical", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/Questionnaire", "http://hl7.org/fhir/StructureDefinition/Measure", "http://hl7.org/fhir/StructureDefinition/OperationDefinition" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.activity.detail.instantiatesUri" }, "comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.", "id": "CarePlan.activity.detail.instantiatesUri", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.instantiatesUri" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ], "max": "0", "min": 0, "path": "CarePlan.activity.detail.instantiatesUri", "requirements": "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.", "short": "Instantiates external protocol or definition", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.activity.detail.code" }, "binding": { "strength": "required", "valueSet": "https://fhir.onehealth.com.pe/ValueSet/careplanactivitycodeOH" }, "comment": "Tends to be less relevant for activities involving particular products. Codes should not convey negation - use \"prohibited\" instead.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.", "id": "CarePlan.activity.detail.code", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.code" }, { "identity": "v2", "map": "OBR-4 / RXE-2 / RXO-1 / RXD-2" }, { "identity": "rim", "map": ".code" } ], "max": "1", "min": 1, "path": "CarePlan.activity.detail.code", "requirements": "Allows matching performed to planned as well as validation against protocols.", "short": "Detail type of activity", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CarePlan.activity.detail.code.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "CarePlan.activity.detail.code.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CarePlan.activity.detail.code.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CarePlan.activity.detail.code.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "CarePlan.activity.detail.code.coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "CarePlan.activity.detail.code.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CarePlan.activity.detail.code.coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "CarePlan.activity.detail.code.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CarePlan.activity.detail.code.coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CarePlan.activity.detail.code.coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "CarePlan.activity.detail.code.coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "CarePlan.activity.detail.code.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "CarePlan.activity.detail.code.coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "CarePlan.activity.detail.code.coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "CarePlan.activity.detail.code.coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "CarePlan.activity.detail.code.coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "CarePlan.activity.detail.code.coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "CarePlan.activity.detail.code.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "CarePlan.activity.detail.code.coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "CarePlan.activity.detail.code.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "CarePlan.activity.detail.code.text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "1", "min": 0, "path": "CarePlan.activity.detail.code.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Textual description for activity", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.activity.detail.reasonCode" }, "binding": { "description": "Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as \"general wellness\", prophylaxis, surgical preparation, etc.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CarePlanActivityReason" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings" }, "comment": "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.", "id": "CarePlan.activity.detail.reasonCode", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.reasonCode" } ], "max": "0", "min": 0, "path": "CarePlan.activity.detail.reasonCode", "short": "Why activity should be done or why activity was prohibited", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.activity.detail.reasonReference" }, "comment": "Conditions can be identified at the activity level that are not identified as reasons for the overall plan.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.", "id": "CarePlan.activity.detail.reasonReference", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.reasonReference" } ], "max": "0", "min": 0, "path": "CarePlan.activity.detail.reasonReference", "short": "Why activity is needed", "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" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.activity.detail.goal" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Internal reference that identifies the goals that this activity is intended to contribute towards meeting.", "id": "CarePlan.activity.detail.goal", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode<=OBJ]." } ], "max": "*", "min": 0, "path": "CarePlan.activity.detail.goal", "requirements": "So that participants know the link explicitly.", "short": "Goals this activity relates to", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/GoalOH" ] } ] }, { "base": { "max": "1", "min": 1, "path": "CarePlan.activity.detail.status" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1" }, "comment": "Some aspects of status can be inferred based on the resources linked in actionTaken. Note that \"status\" is only as current as the plan was most recently updated. \nThe 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 activity.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies what progress is being made for the specific activity.", "id": "CarePlan.activity.detail.status", "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 activity should not be treated as valid", "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.status" }, { "identity": "v2", "map": "ORC-5?" }, { "identity": "rim", "map": ".statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted" } ], "max": "1", "min": 1, "path": "CarePlan.activity.detail.status", "requirements": "Indicates progress against the plan, whether the activity is still relevant for the plan.", "short": "not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.activity.detail.statusReason" }, "comment": "Will generally not be present if status is \"complete\". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.", "id": "CarePlan.activity.detail.statusReason", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.statusReason" } ], "max": "0", "min": 0, "path": "CarePlan.activity.detail.statusReason", "short": "Reason for current status", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.activity.detail.doNotPerform" }, "comment": "This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.", "id": "CarePlan.activity.detail.doNotPerform", "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": false, "mapping": [ { "identity": "workflow", "map": "Request.doNotPerform" }, { "identity": "rim", "map": "actionNegationInd" } ], "max": "0", "meaningWhenMissing": "If missing indicates that the described activity is one that should be engaged in when following the plan.", "min": 0, "path": "CarePlan.activity.detail.doNotPerform", "requirements": "Captures intention to not do something that may have been previously typical.", "short": "If true, activity is prohibiting action", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.activity.detail.scheduled[x]" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The period upon which the described activity is to occur.", "id": "CarePlan.activity.detail.scheduled[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.occurrence[x]" }, { "identity": "v2", "map": "TQ1" }, { "identity": "rim", "map": ".effectiveTime" } ], "max": "1", "min": 0, "path": "CarePlan.activity.detail.scheduled[x]", "requirements": "Allows prompting for activities and detection of missed planned activities.", "short": "When activity is to occur", "type": [ { "code": "Period" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CarePlan.activity.detail.scheduled[x].id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "CarePlan.activity.detail.scheduled[x].id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CarePlan.activity.detail.scheduled[x].extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CarePlan.activity.detail.scheduled[x].extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.start" }, "comment": "If the low element is missing, the meaning is that the low boundary is not known.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The start of the period. The boundary is inclusive.", "id": "CarePlan.activity.detail.scheduled[x].start", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ], "max": "1", "min": 1, "path": "CarePlan.activity.detail.scheduled[x].start", "short": "Starting time with inclusive boundary", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "Period.end" }, "comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.", "condition": [ "per-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "id": "CarePlan.activity.detail.scheduled[x].end", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ], "max": "1", "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "min": 1, "path": "CarePlan.activity.detail.scheduled[x].end", "short": "End time with inclusive boundary, if not ongoing", "type": [ { "code": "dateTime" } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.activity.detail.location" }, "comment": "May reference a specific clinical location or may identify a type of location.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.", "id": "CarePlan.activity.detail.location", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBR-24(???!!)" }, { "identity": "rim", "map": ".participation[typeCode=LOC].role" } ], "max": "1", "min": 0, "path": "CarePlan.activity.detail.location", "requirements": "Helps in planning of activity.", "short": "Where it should happen", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/LocationOH" ] } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.activity.detail.performer" }, "comment": "A performer MAY also be a participant in the care plan.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies who's expected to be involved in the activity.", "id": "CarePlan.activity.detail.performer", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.performer" }, { "identity": "v2", "map": "PRT-5 : ( PRV-4 = (provider participations)); PRT-5 : ( PRV-4 = (non-provider person participations )) ; PRT-5 : ( PRV-4 = (patient non-subject of care) ) ; PRT-8" }, { "identity": "rim", "map": ".participation[typeCode=PFM]" } ], "max": "*", "min": 0, "path": "CarePlan.activity.detail.performer", "requirements": "Helps in planning of activity.", "short": "Who will be responsible?", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH", "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH", "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH", "https://fhir.onehealth.com.pe/StructureDefinition/CareTeamOH", "https://fhir.onehealth.com.pe/StructureDefinition/HealthcareServiceOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.activity.detail.product[x]" }, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/medication-codes" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the food, drug or other product to be consumed or supplied in the activity.", "id": "CarePlan.activity.detail.product[x]", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "RXE-2 / RXO-1 / RXD-2" }, { "identity": "rim", "map": ".participation[typeCode=PRD].role" } ], "max": "1", "min": 0, "path": "CarePlan.activity.detail.product[x]", "short": "What is to be administered/supplied", "type": [ { "code": "CodeableConcept" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CarePlan.activity.detail.product[x].id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "CarePlan.activity.detail.product[x].id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CarePlan.activity.detail.product[x].extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CarePlan.activity.detail.product[x].extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A reference to a code defined by a terminology system.", "id": "CarePlan.activity.detail.product[x].coding", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ], "max": "*", "min": 0, "path": "CarePlan.activity.detail.product[x].coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "short": "Code defined by a terminology system", "type": [ { "code": "Coding" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "CarePlan.activity.detail.product[x].coding.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "0", "min": 0, "path": "CarePlan.activity.detail.product[x].coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "CarePlan.activity.detail.product[x].coding.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "CarePlan.activity.detail.product[x].coding.extension", "short": "Additional content defined by implementations", "slicing": { "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ], "rules": "open" }, "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.system" }, "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "id": "CarePlan.activity.detail.product[x].coding.system", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ], "max": "1", "min": 1, "path": "CarePlan.activity.detail.product[x].coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "short": "Identity of the terminology system", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.version" }, "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "id": "CarePlan.activity.detail.product[x].coding.version", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ], "max": "0", "min": 0, "path": "CarePlan.activity.detail.product[x].coding.version", "short": "Version of the system - if relevant", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.code" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "id": "CarePlan.activity.detail.product[x].coding.code", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ], "max": "1", "min": 1, "path": "CarePlan.activity.detail.product[x].coding.code", "requirements": "Need to refer to a particular code in the system.", "short": "Symbol in syntax defined by the system", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.display" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "CarePlan.activity.detail.product[x].coding.display", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ], "max": "1", "min": 1, "path": "CarePlan.activity.detail.product[x].coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "short": "Representation defined by the system", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "id": "CarePlan.activity.detail.product[x].coding.userSelected", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ], "max": "0", "min": 0, "path": "CarePlan.activity.detail.product[x].coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "short": "If this coding was chosen directly by the user", "type": [ { "code": "boolean" } ] }, { "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "comment": "Very often the text is the same as a displayName of one of the codings.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "id": "CarePlan.activity.detail.product[x].text", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ], "max": "0", "min": 0, "path": "CarePlan.activity.detail.product[x].text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "short": "Plain text representation of the concept", "type": [ { "code": "string" } ] }, { "alias": [ "daily dose" ], "base": { "max": "1", "min": 0, "path": "CarePlan.activity.detail.dailyAmount" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the quantity expected to be consumed in a given day.", "id": "CarePlan.activity.detail.dailyAmount", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "RXO-23 / RXE-19 / RXD-12" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity" } ], "max": "0", "min": 0, "path": "CarePlan.activity.detail.dailyAmount", "requirements": "Allows rough dose checking.", "short": "How to consume/day?", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.activity.detail.quantity" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Identifies the quantity expected to be supplied, administered or consumed by the subject.", "id": "CarePlan.activity.detail.quantity", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP][classCode=SPLY].quantity" } ], "max": "0", "min": 0, "path": "CarePlan.activity.detail.quantity", "short": "How much to administer/supply/consume", "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ] }, { "base": { "max": "1", "min": 0, "path": "CarePlan.activity.detail.description" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.", "id": "CarePlan.activity.detail.description", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "NTE?" }, { "identity": "rim", "map": ".text" } ], "max": "1", "min": 0, "path": "CarePlan.activity.detail.description", "short": "Extra info describing activity to perform", "type": [ { "code": "string" } ] }, { "base": { "max": "*", "min": 0, "path": "CarePlan.note" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "General notes about the care plan not covered elsewhere.", "id": "CarePlan.note", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "workflow", "map": "Request.note" }, { "identity": "v2", "map": "NTE?" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value" } ], "max": "*", "min": 0, "path": "CarePlan.note", "requirements": "Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.", "short": "Comments about the plan", "type": [ { "code": "Annotation" } ] } ] }, "status": "draft", "title": "OneHealth CarePlan", "type": "CarePlan", "url": "https://fhir.onehealth.com.pe/StructureDefinition/CarePlanOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/BundleResultsOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-01-15", "derivation": "constraint", "description": "BundleResultsOH Profile, for OH interoperability scenarios, based on the national CORE Bundle Profile defined by HL7 OH.", "differential": { "element": [ { "definition": "Results Bundle OH FHIR Implementation Guide.", "id": "Bundle", "path": "Bundle", "short": "Results OH Bundle" }, { "id": "Bundle.timestamp", "min": 1, "path": "Bundle.timestamp" }, { "id": "Bundle.link", "max": "0", "path": "Bundle.link" }, { "definition": "An entry resource included in the Affiliate News OH resource.", "id": "Bundle.entry", "min": 8, "path": "Bundle.entry", "short": "Entry resource in the Affiliate News OH bundle", "slicing": { "discriminator": [ { "path": "id", "type": "pattern" } ], "rules": "closed" } }, { "id": "Bundle.entry:documentReferenceRes", "max": "1", "min": 1, "path": "Bundle.entry", "sliceName": "documentReferenceRes" }, { "id": "Bundle.entry:documentReferenceRes.id", "min": 1, "path": "Bundle.entry.id", "patternString": "documentReferenceRes-0" }, { "id": "Bundle.entry:documentReferenceRes.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:documentReferenceRes.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:documentReferenceRes.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "DocumentReference", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/DocumentReferenceOH" ] } ] }, { "id": "Bundle.entry:diagnosticReportLaboratoryRes", "max": "1", "min": 0, "path": "Bundle.entry", "sliceName": "diagnosticReportLaboratoryRes" }, { "id": "Bundle.entry:diagnosticReportLaboratoryRes.id", "min": 1, "path": "Bundle.entry.id", "patternString": "diagnosticReportLaboratoryRes-0" }, { "id": "Bundle.entry:diagnosticReportLaboratoryRes.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:diagnosticReportLaboratoryRes.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:diagnosticReportLaboratoryRes.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "DiagnosticReport", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/DiagnosticReportLaboratoryOH" ] } ] }, { "id": "Bundle.entry:diagnosticReportNoteExchangeRes", "max": "1", "min": 0, "path": "Bundle.entry", "sliceName": "diagnosticReportNoteExchangeRes" }, { "id": "Bundle.entry:diagnosticReportNoteExchangeRes.id", "min": 1, "path": "Bundle.entry.id", "patternString": "diagnosticReportNoteExchangeRes-0" }, { "id": "Bundle.entry:diagnosticReportNoteExchangeRes.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:diagnosticReportNoteExchangeRes.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:diagnosticReportNoteExchangeRes.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "DiagnosticReport", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/DiagnosticReportNoteExchangeOH" ] } ] }, { "id": "Bundle.entry:obsBasicLaboratoryRes", "max": "*", "min": 0, "path": "Bundle.entry", "sliceName": "obsBasicLaboratoryRes" }, { "id": "Bundle.entry:obsBasicLaboratoryRes.id", "min": 1, "path": "Bundle.entry.id", "patternString": "obsBasicLaboratoryRes-0" }, { "id": "Bundle.entry:obsBasicLaboratoryRes.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:obsBasicLaboratoryRes.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:obsBasicLaboratoryRes.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBasicLaboratoryOH" ] } ] }, { "id": "Bundle.entry:patientRes", "max": "1", "min": 1, "path": "Bundle.entry", "sliceName": "patientRes" }, { "id": "Bundle.entry:patientRes.id", "min": 1, "path": "Bundle.entry.id", "patternString": "patientRes-0" }, { "id": "Bundle.entry:patientRes.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:patientRes.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:patientRes.resource", "path": "Bundle.entry.resource", "type": [ { "code": "Patient", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Bundle.entry:personRes", "max": "*", "min": 2, "path": "Bundle.entry", "sliceName": "personRes" }, { "id": "Bundle.entry:personRes.id", "min": 1, "path": "Bundle.entry.id", "patternString": "personRes-0" }, { "id": "Bundle.entry:personRes.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:personRes.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:personRes.resource", "path": "Bundle.entry.resource", "type": [ { "code": "Person", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PersonOH" ] } ] }, { "id": "Bundle.entry:practitionerRes", "max": "*", "min": 1, "path": "Bundle.entry", "sliceName": "practitionerRes" }, { "id": "Bundle.entry:practitionerRes.id", "min": 1, "path": "Bundle.entry.id", "patternString": "practitionerRes-0" }, { "id": "Bundle.entry:practitionerRes.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:practitionerRes.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:practitionerRes.resource", "path": "Bundle.entry.resource", "type": [ { "code": "Practitioner", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH" ] } ] }, { "id": "Bundle.entry:practitionerRoleRes", "max": "*", "min": 1, "path": "Bundle.entry", "sliceName": "practitionerRoleRes" }, { "id": "Bundle.entry:practitionerRoleRes.id", "min": 1, "path": "Bundle.entry.id", "patternString": "practitionerRoleRes-0" }, { "id": "Bundle.entry:practitionerRoleRes.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:practitionerRoleRes.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:practitionerRoleRes.resource", "path": "Bundle.entry.resource", "type": [ { "code": "PractitionerRole", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "Bundle.entry:organizationRes", "max": "*", "min": 1, "path": "Bundle.entry", "sliceName": "organizationRes" }, { "id": "Bundle.entry:organizationRes.id", "min": 1, "path": "Bundle.entry.id", "patternString": "organizationRes-0" }, { "id": "Bundle.entry:organizationRes.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:organizationRes.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:organizationRes.resource", "path": "Bundle.entry.resource", "type": [ { "code": "Organization", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Bundle.entry:healthcareServiceRes", "max": "1", "min": 1, "path": "Bundle.entry", "sliceName": "healthcareServiceRes" }, { "id": "Bundle.entry:healthcareServiceRes.id", "min": 1, "path": "Bundle.entry.id", "patternString": "healthcareServiceRes-0" }, { "id": "Bundle.entry:healthcareServiceRes.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:healthcareServiceRes.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:healthcareServiceRes.resource", "path": "Bundle.entry.resource", "type": [ { "code": "HealthcareService", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/HealthcareServiceOH" ] } ] } ] }, "fhirVersion": "4.0.1", "id": "BundleResultsOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "cda", "name": "CDA (R2)", "uri": "http://hl7.org/v3/cda" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" } ], "meta": { "lastUpdated": "2024-04-12T17:46:12.73235+00:00", "versionId": "MTcxMjk0Mzk3MjczMjM1MDAwMA" }, "name": "BundleResultsOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Bundle" }, "constraint": [ { "expression": "total.empty() or (type = 'searchset') or (type = 'history')", "human": "total only when a search or history", "key": "bdl-1", "severity": "error", "xpath": "not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history')" }, { "expression": "entry.search.empty() or (type = 'searchset')", "human": "entry.search only when a search", "key": "bdl-2", "severity": "error", "xpath": "not(f:entry/f:search) or (f:type/@value = 'searchset')" }, { "expression": "entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))", "human": "entry.request mandatory for batch/transaction/history, otherwise prohibited", "key": "bdl-3", "severity": "error", "xpath": "not(f:entry/f:request) or (f:type/@value = 'batch') or (f:type/@value = 'transaction') or (f:type/@value = 'history')" }, { "expression": "entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))", "human": "entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited", "key": "bdl-4", "severity": "error", "xpath": "not(f:entry/f:response) or (f:type/@value = 'batch-response') or (f:type/@value = 'transaction-response') or (f:type/@value = 'history')" }, { "expression": "(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()", "human": "FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)", "key": "bdl-7", "severity": "error", "xpath": "(f:type/@value = 'history') or (count(for $entry in f:entry[f:resource] return $entry[count(parent::f:Bundle/f:entry[f:fullUrl/@value=$entry/f:fullUrl/@value and ((not(f:resource/*/f:meta/f:versionId/@value) and not($entry/f:resource/*/f:meta/f:versionId/@value)) or f:resource/*/f:meta/f:versionId/@value=$entry/f:resource/*/f:meta/f:versionId/@value)])!=1])=0)" }, { "expression": "type = 'document' implies (identifier.system.exists() and identifier.value.exists())", "human": "A document must have an identifier with a system and a value", "key": "bdl-9", "severity": "error", "xpath": "not(f:type/@value = 'document') or exists(f:identifier/f:system) or exists(f:identifier/f:value)" }, { "expression": "type = 'document' implies (timestamp.hasValue())", "human": "A document must have a date", "key": "bdl-10", "severity": "error", "xpath": "not(f:type/@value = 'document') or exists(f:timestamp/@value)" }, { "expression": "type = 'document' implies entry.first().resource.is(Composition)", "human": "A document must have a Composition as the first resource", "key": "bdl-11", "severity": "error", "xpath": "not(f:type/@value='document') or f:entry[1]/f:resource/f:Composition" }, { "expression": "type = 'message' implies entry.first().resource.is(MessageHeader)", "human": "A message must have a MessageHeader as the first resource", "key": "bdl-12", "severity": "error", "xpath": "not(f:type/@value='message') or f:entry[1]/f:resource/f:MessageHeader" } ], "definition": "Results Bundle OH FHIR Implementation Guide.", "id": "Bundle", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "N/A" }, { "identity": "cda", "map": "ClinicalDocument, if bundle.type = document" } ], "max": "*", "min": 0, "path": "Bundle", "short": "Results OH Bundle" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Bundle.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Bundle.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Bundle.implicitRules", "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, "max": "1", "min": 0, "path": "Bundle.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Bundle.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Bundle.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.identifier" }, "comment": "Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A persistent identifier for the bundle that won't change as a bundle is copied from server to server.", "id": "Bundle.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "cda", "map": "ClinicalDocument.id" } ], "max": "1", "min": 0, "path": "Bundle.identifier", "short": "Persistent identifier for the bundle", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.type" }, "binding": { "description": "Indicates the purpose of a bundle - how it is intended to be used.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BundleType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/bundle-type|4.0.1" }, "comment": "It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the purpose of this bundle - how it is intended to be used.", "id": "Bundle.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" } ], "max": "1", "min": 1, "path": "Bundle.type", "short": "document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.timestamp" }, "comment": "For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. \n\nUsage:\n\n* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time\n* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message\n* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates\n* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query\n* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning\n\nThe timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.", "id": "Bundle.timestamp", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.init" }, { "identity": "cda", "map": "ClinicalDocument.effectiveTime" } ], "max": "1", "min": 1, "path": "Bundle.timestamp", "short": "When the bundle was assembled", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.total" }, "comment": "Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.", "condition": [ "bdl-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.", "id": "Bundle.total", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.total", "short": "If search, the total number of matches", "type": [ { "code": "unsignedInt" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.link" }, "comment": "Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). \n\nBundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.\n\nThis specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A series of links that provide context to this bundle.", "id": "Bundle.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.link", "short": "Links related to this Bundle", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.link.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.link.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.link.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.link.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.link.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.link.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.link.relation" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).", "id": "Bundle.link.relation", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.link.relation", "short": "See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.link.url" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The reference details for the link.", "id": "Bundle.link.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.link.url", "short": "Reference details for the link", "type": [ { "code": "uri" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Affiliate News OH resource.", "id": "Bundle.entry", "isModifier": false, "isSummary": true, "max": "*", "min": 8, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Affiliate News OH bundle", "slicing": { "discriminator": [ { "path": "id", "type": "pattern" } ], "rules": "closed" }, "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry.link", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Resource" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Affiliate News OH resource.", "id": "Bundle.entry:documentReferenceRes", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Affiliate News OH bundle", "sliceName": "documentReferenceRes", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:documentReferenceRes.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "documentReferenceRes-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:documentReferenceRes.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:documentReferenceRes.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:documentReferenceRes.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:documentReferenceRes.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:documentReferenceRes.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "DocumentReference", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/DocumentReferenceOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:documentReferenceRes.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:documentReferenceRes.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:documentReferenceRes.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:documentReferenceRes.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:documentReferenceRes.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:documentReferenceRes.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:documentReferenceRes.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:documentReferenceRes.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:documentReferenceRes.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:documentReferenceRes.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:documentReferenceRes.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:documentReferenceRes.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:documentReferenceRes.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:documentReferenceRes.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:documentReferenceRes.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:documentReferenceRes.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:documentReferenceRes.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:documentReferenceRes.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:documentReferenceRes.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:documentReferenceRes.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:documentReferenceRes.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:documentReferenceRes.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:documentReferenceRes.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:documentReferenceRes.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:documentReferenceRes.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Affiliate News OH resource.", "id": "Bundle.entry:diagnosticReportLaboratoryRes", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Affiliate News OH bundle", "sliceName": "diagnosticReportLaboratoryRes", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "diagnosticReportLaboratoryRes-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:diagnosticReportLaboratoryRes.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "DiagnosticReport", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/DiagnosticReportLaboratoryOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:diagnosticReportLaboratoryRes.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:diagnosticReportLaboratoryRes.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:diagnosticReportLaboratoryRes.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:diagnosticReportLaboratoryRes.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:diagnosticReportLaboratoryRes.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:diagnosticReportLaboratoryRes.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:diagnosticReportLaboratoryRes.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:diagnosticReportLaboratoryRes.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:diagnosticReportLaboratoryRes.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:diagnosticReportLaboratoryRes.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Affiliate News OH resource.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Affiliate News OH bundle", "sliceName": "diagnosticReportNoteExchangeRes", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "diagnosticReportNoteExchangeRes-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "DiagnosticReport", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/DiagnosticReportNoteExchangeOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:diagnosticReportNoteExchangeRes.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Affiliate News OH resource.", "id": "Bundle.entry:obsBasicLaboratoryRes", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Affiliate News OH bundle", "sliceName": "obsBasicLaboratoryRes", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBasicLaboratoryRes.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "obsBasicLaboratoryRes-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBasicLaboratoryRes.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBasicLaboratoryRes.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:obsBasicLaboratoryRes.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:obsBasicLaboratoryRes.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:obsBasicLaboratoryRes.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBasicLaboratoryOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:obsBasicLaboratoryRes.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBasicLaboratoryRes.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBasicLaboratoryRes.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBasicLaboratoryRes.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:obsBasicLaboratoryRes.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:obsBasicLaboratoryRes.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:obsBasicLaboratoryRes.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBasicLaboratoryRes.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBasicLaboratoryRes.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBasicLaboratoryRes.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:obsBasicLaboratoryRes.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:obsBasicLaboratoryRes.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsBasicLaboratoryRes.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsBasicLaboratoryRes.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:obsBasicLaboratoryRes.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:obsBasicLaboratoryRes.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:obsBasicLaboratoryRes.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBasicLaboratoryRes.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBasicLaboratoryRes.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBasicLaboratoryRes.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:obsBasicLaboratoryRes.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:obsBasicLaboratoryRes.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:obsBasicLaboratoryRes.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:obsBasicLaboratoryRes.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:obsBasicLaboratoryRes.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Affiliate News OH resource.", "id": "Bundle.entry:patientRes", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Affiliate News OH bundle", "sliceName": "patientRes", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:patientRes.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "patientRes-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:patientRes.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:patientRes.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:patientRes.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:patientRes.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:patientRes.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Patient", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:patientRes.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:patientRes.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:patientRes.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:patientRes.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:patientRes.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:patientRes.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:patientRes.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:patientRes.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:patientRes.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:patientRes.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:patientRes.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:patientRes.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:patientRes.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:patientRes.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:patientRes.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:patientRes.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:patientRes.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:patientRes.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:patientRes.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:patientRes.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:patientRes.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:patientRes.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:patientRes.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:patientRes.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:patientRes.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Affiliate News OH resource.", "id": "Bundle.entry:personRes", "isModifier": false, "isSummary": true, "max": "*", "min": 2, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Affiliate News OH bundle", "sliceName": "personRes", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:personRes.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "personRes-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:personRes.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:personRes.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:personRes.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:personRes.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:personRes.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Person", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PersonOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:personRes.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:personRes.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:personRes.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:personRes.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:personRes.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:personRes.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:personRes.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:personRes.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:personRes.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:personRes.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:personRes.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:personRes.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:personRes.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:personRes.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:personRes.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:personRes.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:personRes.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:personRes.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:personRes.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:personRes.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:personRes.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:personRes.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:personRes.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:personRes.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:personRes.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Affiliate News OH resource.", "id": "Bundle.entry:practitionerRes", "isModifier": false, "isSummary": true, "max": "*", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Affiliate News OH bundle", "sliceName": "practitionerRes", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerRes.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "practitionerRes-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerRes.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerRes.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:practitionerRes.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:practitionerRes.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:practitionerRes.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Practitioner", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:practitionerRes.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerRes.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerRes.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerRes.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:practitionerRes.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:practitionerRes.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:practitionerRes.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerRes.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerRes.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerRes.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:practitionerRes.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:practitionerRes.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:practitionerRes.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:practitionerRes.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:practitionerRes.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:practitionerRes.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:practitionerRes.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerRes.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerRes.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerRes.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:practitionerRes.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:practitionerRes.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:practitionerRes.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:practitionerRes.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:practitionerRes.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Affiliate News OH resource.", "id": "Bundle.entry:practitionerRoleRes", "isModifier": false, "isSummary": true, "max": "*", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Affiliate News OH bundle", "sliceName": "practitionerRoleRes", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerRoleRes.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "practitionerRoleRes-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerRoleRes.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerRoleRes.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:practitionerRoleRes.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:practitionerRoleRes.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:practitionerRoleRes.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "PractitionerRole", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:practitionerRoleRes.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerRoleRes.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerRoleRes.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerRoleRes.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:practitionerRoleRes.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:practitionerRoleRes.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:practitionerRoleRes.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerRoleRes.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerRoleRes.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerRoleRes.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:practitionerRoleRes.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:practitionerRoleRes.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:practitionerRoleRes.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:practitionerRoleRes.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:practitionerRoleRes.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:practitionerRoleRes.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:practitionerRoleRes.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerRoleRes.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerRoleRes.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerRoleRes.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:practitionerRoleRes.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:practitionerRoleRes.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:practitionerRoleRes.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:practitionerRoleRes.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:practitionerRoleRes.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Affiliate News OH resource.", "id": "Bundle.entry:organizationRes", "isModifier": false, "isSummary": true, "max": "*", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Affiliate News OH bundle", "sliceName": "organizationRes", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:organizationRes.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "organizationRes-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:organizationRes.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:organizationRes.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:organizationRes.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:organizationRes.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:organizationRes.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Organization", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:organizationRes.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:organizationRes.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:organizationRes.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:organizationRes.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:organizationRes.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:organizationRes.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:organizationRes.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:organizationRes.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:organizationRes.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:organizationRes.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:organizationRes.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:organizationRes.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:organizationRes.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:organizationRes.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:organizationRes.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:organizationRes.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:organizationRes.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:organizationRes.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:organizationRes.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:organizationRes.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:organizationRes.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:organizationRes.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:organizationRes.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:organizationRes.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:organizationRes.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Affiliate News OH resource.", "id": "Bundle.entry:healthcareServiceRes", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Affiliate News OH bundle", "sliceName": "healthcareServiceRes", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:healthcareServiceRes.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "healthcareServiceRes-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:healthcareServiceRes.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:healthcareServiceRes.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:healthcareServiceRes.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:healthcareServiceRes.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:healthcareServiceRes.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "HealthcareService", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/HealthcareServiceOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:healthcareServiceRes.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:healthcareServiceRes.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:healthcareServiceRes.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:healthcareServiceRes.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:healthcareServiceRes.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:healthcareServiceRes.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:healthcareServiceRes.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:healthcareServiceRes.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:healthcareServiceRes.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:healthcareServiceRes.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:healthcareServiceRes.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:healthcareServiceRes.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:healthcareServiceRes.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:healthcareServiceRes.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:healthcareServiceRes.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:healthcareServiceRes.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:healthcareServiceRes.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:healthcareServiceRes.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:healthcareServiceRes.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:healthcareServiceRes.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:healthcareServiceRes.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:healthcareServiceRes.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:healthcareServiceRes.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:healthcareServiceRes.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:healthcareServiceRes.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.signature" }, "comment": "The signature could be created by the \"author\" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Digital Signature - base64 encoded. XML-DSig or a JWT.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "id": "Bundle.signature", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.signature", "requirements": "A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.", "short": "Digital Signature", "type": [ { "code": "Signature" } ] } ] }, "status": "draft", "title": "OneHealth BundleResults", "type": "Bundle", "url": "https://fhir.onehealth.com.pe/StructureDefinition/BundleResultsOH", "version": "1.0" }, "search": { "mode": "match" } }, { "fullUrl": "https://healthcare.googleapis.com/v1/projects/ci-applications-dev-356920/locations/us-east1/datasets/gcp-ci-interoper-dataset-dev-h1/fhirStores/gcp-ci-interoper-his-dev-h1-R4/fhir/StructureDefinition/BundleOutpatientEncounterOH", "resource": { "abstract": false, "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle", "contact": [ { "name": "Esteban Nesci", "telecom": [ { "system": "email", "use": "work", "value": "esteban.nesci@zentricx.com" } ] }, { "name": "Fernando Mario La Rosa", "telecom": [ { "system": "email", "use": "work", "value": "fernando.larosa@zentricx.com" } ] }, { "name": "Alejandro Gómez Fernandez", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.gomezfernandez@zentricx.com" } ] }, { "name": "Mercedes Francos", "telecom": [ { "system": "email", "use": "work", "value": "mercedes.francos@zentricx.com" } ] }, { "name": "Alejandro Trotta", "telecom": [ { "system": "email", "use": "work", "value": "alejandro.trotta@zentricx.com" } ] }, { "name": "Agustin Galarza", "telecom": [ { "system": "email", "use": "work", "value": "agustin.galarza@zentricx.com" } ] }, { "name": "Daniel Rubio", "telecom": [ { "system": "email", "use": "work", "value": "daniel@zentricx.com" } ] }, { "name": "Gonzalo Arena", "telecom": [ { "system": "email", "use": "work", "value": "gonzalo.arena@zentricx.com" } ] }, { "name": "Florencia Ibarra", "telecom": [ { "system": "email", "use": "work", "value": "florencia.ibarra@zentricx.com" } ] } ], "copyright": "Zentricx 2023+", "date": "2024-02-01", "derivation": "constraint", "description": "FHIR BundleOutpatientEncounterOH Profile, for OH interoperability scenarios, based on the national CORE Bundle Profile defined by HL7 OH.", "differential": { "element": [ { "definition": "Outpatient Encounter Bundle OH FHIR Implementation Guide.", "id": "Bundle", "path": "Bundle", "short": "Outpatient Encounter OH Bundle" }, { "id": "Bundle.timestamp", "min": 1, "path": "Bundle.timestamp" }, { "id": "Bundle.link", "max": "0", "path": "Bundle.link" }, { "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry", "min": 12, "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "slicing": { "discriminator": [ { "path": "id", "type": "pattern" } ], "rules": "closed" } }, { "id": "Bundle.entry:patientOut", "max": "1", "min": 1, "path": "Bundle.entry", "sliceName": "patientOut" }, { "id": "Bundle.entry:patientOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "patientOut-0" }, { "id": "Bundle.entry:patientOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:patientOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:patientOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Patient", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "id": "Bundle.entry:personOut", "max": "*", "min": 2, "path": "Bundle.entry", "sliceName": "personOut" }, { "id": "Bundle.entry:personOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "personOut-0" }, { "id": "Bundle.entry:personOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:personOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:personOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Person", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PersonOH" ] } ] }, { "id": "Bundle.entry:practitionerOut", "max": "*", "min": 1, "path": "Bundle.entry", "sliceName": "practitionerOut" }, { "id": "Bundle.entry:practitionerOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "practitionerOut-0" }, { "id": "Bundle.entry:practitionerOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:practitionerOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:practitionerOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Practitioner", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH" ] } ] }, { "id": "Bundle.entry:practitionerRoleOut", "max": "*", "min": 1, "path": "Bundle.entry", "sliceName": "practitionerRoleOut" }, { "id": "Bundle.entry:practitionerRoleOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "practitionerRoleOut-0" }, { "id": "Bundle.entry:practitionerRoleOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:practitionerRoleOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:practitionerRoleOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "PractitionerRole", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "id": "Bundle.entry:healthCareServiceOut", "max": "1", "min": 1, "path": "Bundle.entry", "sliceName": "healthCareServiceOut" }, { "id": "Bundle.entry:healthCareServiceOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "healthCareServiceOut-0" }, { "id": "Bundle.entry:healthCareServiceOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:healthCareServiceOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:healthCareServiceOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "HealthcareService", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/HealthcareServiceOH" ] } ] }, { "id": "Bundle.entry:organizationOut", "max": "*", "min": 1, "path": "Bundle.entry", "sliceName": "organizationOut" }, { "id": "Bundle.entry:organizationOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "organizationOut-0" }, { "id": "Bundle.entry:organizationOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:organizationOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:organizationOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Organization", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "id": "Bundle.entry:locationOut", "max": "1", "min": 1, "path": "Bundle.entry", "sliceName": "locationOut" }, { "id": "Bundle.entry:locationOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "locationOut-0" }, { "id": "Bundle.entry:locationOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:locationOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:locationOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Location", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/LocationOH" ] } ] }, { "id": "Bundle.entry:appointmentOut", "max": "1", "min": 0, "path": "Bundle.entry", "sliceName": "appointmentOut" }, { "id": "Bundle.entry:appointmentOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "appointmentOut-0" }, { "id": "Bundle.entry:appointmentOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:appointmentOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:appointmentOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Appointment", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/AppointmentOH" ] } ] }, { "id": "Bundle.entry:encounterOut", "max": "1", "min": 1, "path": "Bundle.entry", "sliceName": "encounterOut" }, { "id": "Bundle.entry:encounterOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "encounterOut-0" }, { "id": "Bundle.entry:encounterOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:encounterOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:encounterOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Encounter", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "id": "Bundle.entry:conditionEncounterDiagnosisOut", "max": "*", "min": 0, "path": "Bundle.entry", "sliceName": "conditionEncounterDiagnosisOut" }, { "id": "Bundle.entry:conditionEncounterDiagnosisOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "conditionEncounterDiagnosisOut-0" }, { "id": "Bundle.entry:conditionEncounterDiagnosisOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:conditionEncounterDiagnosisOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:conditionEncounterDiagnosisOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Condition", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH" ] } ] }, { "id": "Bundle.entry:conditionProblemListItemOut", "max": "*", "min": 0, "path": "Bundle.entry", "sliceName": "conditionProblemListItemOut" }, { "id": "Bundle.entry:conditionProblemListItemOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "conditionProblemListItemOut-0" }, { "id": "Bundle.entry:conditionProblemListItemOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:conditionProblemListItemOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:conditionProblemListItemOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Condition", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionProblemListItemOH" ] } ] }, { "id": "Bundle.entry:allergyIntoleranceOut", "max": "*", "min": 0, "path": "Bundle.entry", "sliceName": "allergyIntoleranceOut" }, { "id": "Bundle.entry:allergyIntoleranceOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "allergyIntoleranceOut-0" }, { "id": "Bundle.entry:allergyIntoleranceOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:allergyIntoleranceOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:allergyIntoleranceOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "AllergyIntolerance", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/AllergyIntoleranceOH" ] } ] }, { "id": "Bundle.entry:documentReferenceOut", "max": "*", "min": 0, "path": "Bundle.entry", "sliceName": "documentReferenceOut" }, { "id": "Bundle.entry:documentReferenceOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "documentReferenceOut-0" }, { "id": "Bundle.entry:documentReferenceOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:documentReferenceOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:documentReferenceOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "DocumentReference", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/DocumentReferenceOH" ] } ] }, { "id": "Bundle.entry:obsBloodGroupOut", "max": "1", "min": 0, "path": "Bundle.entry", "sliceName": "obsBloodGroupOut" }, { "id": "Bundle.entry:obsBloodGroupOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "obsBloodGroupOut-0" }, { "id": "Bundle.entry:obsBloodGroupOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:obsBloodGroupOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:obsBloodGroupOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBloodGroupOH" ] } ] }, { "id": "Bundle.entry:obsRhFactorOut", "max": "1", "min": 0, "path": "Bundle.entry", "sliceName": "obsRhFactorOut" }, { "id": "Bundle.entry:obsRhFactorOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "obsRhFactorOut-0" }, { "id": "Bundle.entry:obsRhFactorOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:obsRhFactorOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:obsRhFactorOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsRhFactorOH" ] } ] }, { "id": "Bundle.entry:obsBodyWeightOut", "max": "1", "min": 0, "path": "Bundle.entry", "sliceName": "obsBodyWeightOut" }, { "id": "Bundle.entry:obsBodyWeightOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "obsBodyWeightOut-0" }, { "id": "Bundle.entry:obsBodyWeightOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:obsBodyWeightOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:obsBodyWeightOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBodyWeightOH" ] } ] }, { "id": "Bundle.entry:obsBodyHeightOut", "max": "1", "min": 0, "path": "Bundle.entry", "sliceName": "obsBodyHeightOut" }, { "id": "Bundle.entry:obsBodyHeightOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "obsBodyHeightOut-0" }, { "id": "Bundle.entry:obsBodyHeightOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:obsBodyHeightOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:obsBodyHeightOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBodyHeightOH" ] } ] }, { "id": "Bundle.entry:obsBMIOut", "max": "1", "min": 0, "path": "Bundle.entry", "sliceName": "obsBMIOut" }, { "id": "Bundle.entry:obsBMIOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "obsBMIOut-0" }, { "id": "Bundle.entry:obsBMIOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:obsBMIOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:obsBMIOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBMIOH" ] } ] }, { "id": "Bundle.entry:serviceResquestOut", "max": "*", "min": 0, "path": "Bundle.entry", "sliceName": "serviceResquestOut" }, { "id": "Bundle.entry:serviceResquestOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "serviceResquestOut-0" }, { "id": "Bundle.entry:serviceResquestOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:serviceResquestOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:serviceResquestOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "ServiceRequest", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ServiceRequestOH" ] } ] }, { "id": "Bundle.entry:requestGroupOut", "max": "*", "min": 0, "path": "Bundle.entry", "sliceName": "requestGroupOut" }, { "id": "Bundle.entry:requestGroupOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "requestGroupOut-0" }, { "id": "Bundle.entry:requestGroupOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:requestGroupOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:requestGroupOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "RequestGroup", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/RequestGroupOH" ] } ] }, { "id": "Bundle.entry:medicationRequestOut", "max": "*", "min": 0, "path": "Bundle.entry", "sliceName": "medicationRequestOut" }, { "id": "Bundle.entry:medicationRequestOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "medicationRequestOut-0" }, { "id": "Bundle.entry:medicationRequestOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:medicationRequestOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:medicationRequestOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "MedicationRequest", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/MedicationRequestOH" ] } ] }, { "id": "Bundle.entry:obsLastMenstrualPeriodOut", "max": "1", "min": 0, "path": "Bundle.entry", "sliceName": "obsLastMenstrualPeriodOut" }, { "id": "Bundle.entry:obsLastMenstrualPeriodOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "obsLastMenstrualPeriodOut-0" }, { "id": "Bundle.entry:obsLastMenstrualPeriodOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:obsLastMenstrualPeriodOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:obsLastMenstrualPeriodOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsLastMenstrualPeriodOH" ] } ] }, { "id": "Bundle.entry:obsEDCOut", "max": "1", "min": 0, "path": "Bundle.entry", "sliceName": "obsEDCOut" }, { "id": "Bundle.entry:obsEDCOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "obsEDCOut-0" }, { "id": "Bundle.entry:obsEDCOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:obsEDCOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:obsEDCOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsEDCOH" ] } ] }, { "id": "Bundle.entry:compositionOut", "max": "1", "min": 1, "path": "Bundle.entry", "sliceName": "compositionOut" }, { "id": "Bundle.entry:compositionOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "compositionOut-0" }, { "id": "Bundle.entry:compositionOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:compositionOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:compositionOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Composition", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/CompositionOutpatientProgressNoteOH" ] } ] }, { "id": "Bundle.entry:coverageOut", "max": "1", "min": 1, "path": "Bundle.entry", "sliceName": "coverageOut" }, { "id": "Bundle.entry:coverageOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "coverageOut-0" }, { "id": "Bundle.entry:coverageOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:coverageOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:coverageOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Coverage", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/CoverageOH" ] } ] }, { "id": "Bundle.entry:obsRecommendationToRestOut", "max": "1", "min": 0, "path": "Bundle.entry", "sliceName": "obsRecommendationToRestOut" }, { "id": "Bundle.entry:obsRecommendationToRestOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "obsRecommendationToRestOut-0" }, { "id": "Bundle.entry:obsRecommendationToRestOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:obsRecommendationToRestOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:obsRecommendationToRestOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsRecommendationToRestOH" ] } ] }, { "id": "Bundle.entry:compositionRecommendationOfRestOut", "max": "1", "min": 0, "path": "Bundle.entry", "sliceName": "compositionRecommendationOfRestOut" }, { "id": "Bundle.entry:compositionRecommendationOfRestOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "compositionRecommendationOfRestOut-0" }, { "id": "Bundle.entry:compositionRecommendationOfRestOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:compositionRecommendationOfRestOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:compositionRecommendationOfRestOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Composition", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/CompositionRecommendationOfRestOH" ] } ] }, { "id": "Bundle.entry:accountOut", "max": "1", "min": 1, "path": "Bundle.entry", "sliceName": "accountOut" }, { "id": "Bundle.entry:accountOut.id", "min": 1, "path": "Bundle.entry.id", "patternString": "accountOut-0" }, { "id": "Bundle.entry:accountOut.link", "max": "0", "path": "Bundle.entry.link" }, { "id": "Bundle.entry:accountOut.fullUrl", "min": 1, "path": "Bundle.entry.fullUrl" }, { "id": "Bundle.entry:accountOut.resource", "min": 1, "path": "Bundle.entry.resource", "type": [ { "code": "Account", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/AccountOH" ] } ] } ] }, "fhirVersion": "4.0.1", "id": "BundleOutpatientEncounterOH", "jurisdiction": [ { "coding": [ { "code": "PE", "display": "Perú", "system": "urn:iso:std:iso:3166:-2" } ] } ], "kind": "resource", "mapping": [ { "identity": "v2", "name": "HL7 v2 Mapping", "uri": "http://hl7.org/v2" }, { "identity": "rim", "name": "RIM Mapping", "uri": "http://hl7.org/v3" }, { "identity": "cda", "name": "CDA (R2)", "uri": "http://hl7.org/v3/cda" }, { "identity": "w5", "name": "FiveWs Pattern Mapping", "uri": "http://hl7.org/fhir/fivews" } ], "meta": { "lastUpdated": "2024-04-12T17:46:12.019412+00:00", "versionId": "MTcxMjk0Mzk3MjAxOTQxMjAwMA" }, "name": "BundleOutpatientEncounterOH", "publisher": "Zentricx", "resourceType": "StructureDefinition", "snapshot": { "element": [ { "base": { "max": "*", "min": 0, "path": "Bundle" }, "constraint": [ { "expression": "total.empty() or (type = 'searchset') or (type = 'history')", "human": "total only when a search or history", "key": "bdl-1", "severity": "error", "xpath": "not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history')" }, { "expression": "entry.search.empty() or (type = 'searchset')", "human": "entry.search only when a search", "key": "bdl-2", "severity": "error", "xpath": "not(f:entry/f:search) or (f:type/@value = 'searchset')" }, { "expression": "entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))", "human": "entry.request mandatory for batch/transaction/history, otherwise prohibited", "key": "bdl-3", "severity": "error", "xpath": "not(f:entry/f:request) or (f:type/@value = 'batch') or (f:type/@value = 'transaction') or (f:type/@value = 'history')" }, { "expression": "entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))", "human": "entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited", "key": "bdl-4", "severity": "error", "xpath": "not(f:entry/f:response) or (f:type/@value = 'batch-response') or (f:type/@value = 'transaction-response') or (f:type/@value = 'history')" }, { "expression": "(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()", "human": "FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)", "key": "bdl-7", "severity": "error", "xpath": "(f:type/@value = 'history') or (count(for $entry in f:entry[f:resource] return $entry[count(parent::f:Bundle/f:entry[f:fullUrl/@value=$entry/f:fullUrl/@value and ((not(f:resource/*/f:meta/f:versionId/@value) and not($entry/f:resource/*/f:meta/f:versionId/@value)) or f:resource/*/f:meta/f:versionId/@value=$entry/f:resource/*/f:meta/f:versionId/@value)])!=1])=0)" }, { "expression": "type = 'document' implies (identifier.system.exists() and identifier.value.exists())", "human": "A document must have an identifier with a system and a value", "key": "bdl-9", "severity": "error", "xpath": "not(f:type/@value = 'document') or exists(f:identifier/f:system) or exists(f:identifier/f:value)" }, { "expression": "type = 'document' implies (timestamp.hasValue())", "human": "A document must have a date", "key": "bdl-10", "severity": "error", "xpath": "not(f:type/@value = 'document') or exists(f:timestamp/@value)" }, { "expression": "type = 'document' implies entry.first().resource.is(Composition)", "human": "A document must have a Composition as the first resource", "key": "bdl-11", "severity": "error", "xpath": "not(f:type/@value='document') or f:entry[1]/f:resource/f:Composition" }, { "expression": "type = 'message' implies entry.first().resource.is(MessageHeader)", "human": "A message must have a MessageHeader as the first resource", "key": "bdl-12", "severity": "error", "xpath": "not(f:type/@value='message') or f:entry[1]/f:resource/f:MessageHeader" } ], "definition": "Outpatient Encounter Bundle OH FHIR Implementation Guide.", "id": "Bundle", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "N/A" }, { "identity": "cda", "map": "ClinicalDocument, if bundle.type = document" } ], "max": "*", "min": 0, "path": "Bundle", "short": "Outpatient Encounter OH Bundle" }, { "base": { "max": "1", "min": 0, "path": "Resource.id" }, "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.", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "id": "Bundle.id", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.id", "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Bundle.meta", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.meta", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "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.", "id": "Bundle.implicitRules", "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, "max": "1", "min": 0, "path": "Bundle.implicitRules", "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Resource.language" }, "binding": { "description": "A human language.", "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", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "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).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The base language in which the resource is written.", "id": "Bundle.language", "isModifier": false, "isSummary": false, "max": "1", "min": 0, "path": "Bundle.language", "short": "Language of the resource content", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.identifier" }, "comment": "Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A persistent identifier for the bundle that won't change as a bundle is copied from server to server.", "id": "Bundle.identifier", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "cda", "map": "ClinicalDocument.id" } ], "max": "1", "min": 0, "path": "Bundle.identifier", "short": "Persistent identifier for the bundle", "type": [ { "code": "Identifier" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.type" }, "binding": { "description": "Indicates the purpose of a bundle - how it is intended to be used.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "BundleType" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/bundle-type|4.0.1" }, "comment": "It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the purpose of this bundle - how it is intended to be used.", "id": "Bundle.type", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.class" } ], "max": "1", "min": 1, "path": "Bundle.type", "short": "document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.timestamp" }, "comment": "For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. \n\nUsage:\n\n* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time\n* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message\n* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates\n* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query\n* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning\n\nThe timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.", "id": "Bundle.timestamp", "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.init" }, { "identity": "cda", "map": "ClinicalDocument.effectiveTime" } ], "max": "1", "min": 1, "path": "Bundle.timestamp", "short": "When the bundle was assembled", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.total" }, "comment": "Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.", "condition": [ "bdl-1" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.", "id": "Bundle.total", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.total", "short": "If search, the total number of matches", "type": [ { "code": "unsignedInt" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.link" }, "comment": "Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). \n\nBundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http.html#read) directly.\n\nThis specification defines some specific uses of Bundle.link for [searching](search.html#conformance) and [paging](http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A series of links that provide context to this bundle.", "id": "Bundle.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.link", "short": "Links related to this Bundle", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.link.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.link.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.link.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.link.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.link.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.link.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.link.relation" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).", "id": "Bundle.link.relation", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.link.relation", "short": "See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.link.url" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The reference details for the link.", "id": "Bundle.link.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.link.url", "short": "Reference details for the link", "type": [ { "code": "uri" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry", "isModifier": false, "isSummary": true, "max": "*", "min": 12, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "slicing": { "discriminator": [ { "path": "id", "type": "pattern" } ], "rules": "closed" }, "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry.link", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Resource" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:patientOut", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "patientOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:patientOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "patientOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:patientOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:patientOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:patientOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:patientOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:patientOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Patient", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PatientOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:patientOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:patientOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:patientOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:patientOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:patientOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:patientOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:patientOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:patientOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:patientOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:patientOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:patientOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:patientOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:patientOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:patientOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:patientOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:patientOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:patientOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:patientOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:patientOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:patientOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:patientOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:patientOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:patientOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:patientOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:patientOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:personOut", "isModifier": false, "isSummary": true, "max": "*", "min": 2, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "personOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:personOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "personOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:personOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:personOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:personOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:personOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:personOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Person", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PersonOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:personOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:personOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:personOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:personOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:personOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:personOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:personOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:personOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:personOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:personOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:personOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:personOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:personOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:personOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:personOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:personOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:personOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:personOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:personOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:personOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:personOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:personOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:personOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:personOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:personOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:practitionerOut", "isModifier": false, "isSummary": true, "max": "*", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "practitionerOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "practitionerOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:practitionerOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:practitionerOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:practitionerOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Practitioner", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:practitionerOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:practitionerOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:practitionerOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:practitionerOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:practitionerOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:practitionerOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:practitionerOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:practitionerOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:practitionerOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:practitionerOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:practitionerOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:practitionerOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:practitionerOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:practitionerOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:practitionerOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:practitionerOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:practitionerRoleOut", "isModifier": false, "isSummary": true, "max": "*", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "practitionerRoleOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerRoleOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "practitionerRoleOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerRoleOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerRoleOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:practitionerRoleOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:practitionerRoleOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:practitionerRoleOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "PractitionerRole", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/PractitionerRoleOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:practitionerRoleOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerRoleOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerRoleOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerRoleOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:practitionerRoleOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:practitionerRoleOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:practitionerRoleOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerRoleOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerRoleOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerRoleOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:practitionerRoleOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:practitionerRoleOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:practitionerRoleOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:practitionerRoleOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:practitionerRoleOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:practitionerRoleOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:practitionerRoleOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:practitionerRoleOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:practitionerRoleOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:practitionerRoleOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:practitionerRoleOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:practitionerRoleOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:practitionerRoleOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:practitionerRoleOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:practitionerRoleOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:healthCareServiceOut", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "healthCareServiceOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:healthCareServiceOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "healthCareServiceOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:healthCareServiceOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:healthCareServiceOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:healthCareServiceOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:healthCareServiceOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:healthCareServiceOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "HealthcareService", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/HealthcareServiceOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:healthCareServiceOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:healthCareServiceOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:healthCareServiceOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:healthCareServiceOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:healthCareServiceOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:healthCareServiceOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:healthCareServiceOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:healthCareServiceOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:healthCareServiceOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:healthCareServiceOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:healthCareServiceOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:healthCareServiceOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:healthCareServiceOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:healthCareServiceOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:healthCareServiceOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:healthCareServiceOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:healthCareServiceOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:healthCareServiceOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:healthCareServiceOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:healthCareServiceOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:healthCareServiceOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:healthCareServiceOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:healthCareServiceOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:healthCareServiceOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:healthCareServiceOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:organizationOut", "isModifier": false, "isSummary": true, "max": "*", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "organizationOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:organizationOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "organizationOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:organizationOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:organizationOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:organizationOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:organizationOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:organizationOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Organization", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/OrganizationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:organizationOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:organizationOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:organizationOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:organizationOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:organizationOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:organizationOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:organizationOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:organizationOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:organizationOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:organizationOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:organizationOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:organizationOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:organizationOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:organizationOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:organizationOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:organizationOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:organizationOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:organizationOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:organizationOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:organizationOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:organizationOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:organizationOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:organizationOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:organizationOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:organizationOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:locationOut", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "locationOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:locationOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "locationOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:locationOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:locationOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:locationOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:locationOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:locationOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Location", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/LocationOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:locationOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:locationOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:locationOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:locationOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:locationOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:locationOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:locationOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:locationOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:locationOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:locationOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:locationOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:locationOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:locationOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:locationOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:locationOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:locationOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:locationOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:locationOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:locationOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:locationOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:locationOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:locationOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:locationOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:locationOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:locationOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:appointmentOut", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "appointmentOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:appointmentOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "appointmentOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:appointmentOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:appointmentOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:appointmentOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:appointmentOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:appointmentOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Appointment", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/AppointmentOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:appointmentOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:appointmentOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:appointmentOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:appointmentOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:appointmentOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:appointmentOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:appointmentOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:appointmentOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:appointmentOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:appointmentOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:appointmentOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:appointmentOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:appointmentOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:appointmentOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:appointmentOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:appointmentOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:appointmentOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:appointmentOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:appointmentOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:appointmentOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:appointmentOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:appointmentOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:appointmentOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:appointmentOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:appointmentOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:encounterOut", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "encounterOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:encounterOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "encounterOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:encounterOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:encounterOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:encounterOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:encounterOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:encounterOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Encounter", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/EncounterOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:encounterOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:encounterOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:encounterOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:encounterOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:encounterOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:encounterOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:encounterOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:encounterOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:encounterOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:encounterOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:encounterOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:encounterOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:encounterOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:encounterOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:encounterOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:encounterOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:encounterOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:encounterOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:encounterOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:encounterOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:encounterOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:encounterOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:encounterOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:encounterOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:encounterOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:conditionEncounterDiagnosisOut", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "conditionEncounterDiagnosisOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "conditionEncounterDiagnosisOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:conditionEncounterDiagnosisOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Condition", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionEncounterDiagnosisOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:conditionEncounterDiagnosisOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:conditionEncounterDiagnosisOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:conditionEncounterDiagnosisOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:conditionEncounterDiagnosisOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:conditionEncounterDiagnosisOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:conditionEncounterDiagnosisOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:conditionEncounterDiagnosisOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:conditionEncounterDiagnosisOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:conditionEncounterDiagnosisOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:conditionEncounterDiagnosisOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:conditionProblemListItemOut", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "conditionProblemListItemOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:conditionProblemListItemOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "conditionProblemListItemOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:conditionProblemListItemOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:conditionProblemListItemOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:conditionProblemListItemOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:conditionProblemListItemOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:conditionProblemListItemOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Condition", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ConditionProblemListItemOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:conditionProblemListItemOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:conditionProblemListItemOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:conditionProblemListItemOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:conditionProblemListItemOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:conditionProblemListItemOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:conditionProblemListItemOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:conditionProblemListItemOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:conditionProblemListItemOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:conditionProblemListItemOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:conditionProblemListItemOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:conditionProblemListItemOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:conditionProblemListItemOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:conditionProblemListItemOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:conditionProblemListItemOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:conditionProblemListItemOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:conditionProblemListItemOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:conditionProblemListItemOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:conditionProblemListItemOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:conditionProblemListItemOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:conditionProblemListItemOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:conditionProblemListItemOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:conditionProblemListItemOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:conditionProblemListItemOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:conditionProblemListItemOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:conditionProblemListItemOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:allergyIntoleranceOut", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "allergyIntoleranceOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:allergyIntoleranceOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "allergyIntoleranceOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:allergyIntoleranceOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:allergyIntoleranceOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:allergyIntoleranceOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:allergyIntoleranceOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:allergyIntoleranceOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "AllergyIntolerance", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/AllergyIntoleranceOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:allergyIntoleranceOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:allergyIntoleranceOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:allergyIntoleranceOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:allergyIntoleranceOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:allergyIntoleranceOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:allergyIntoleranceOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:allergyIntoleranceOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:allergyIntoleranceOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:allergyIntoleranceOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:allergyIntoleranceOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:allergyIntoleranceOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:allergyIntoleranceOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:allergyIntoleranceOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:allergyIntoleranceOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:allergyIntoleranceOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:allergyIntoleranceOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:allergyIntoleranceOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:allergyIntoleranceOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:allergyIntoleranceOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:allergyIntoleranceOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:allergyIntoleranceOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:allergyIntoleranceOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:allergyIntoleranceOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:allergyIntoleranceOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:allergyIntoleranceOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:documentReferenceOut", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "documentReferenceOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:documentReferenceOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "documentReferenceOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:documentReferenceOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:documentReferenceOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:documentReferenceOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:documentReferenceOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:documentReferenceOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "DocumentReference", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/DocumentReferenceOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:documentReferenceOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:documentReferenceOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:documentReferenceOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:documentReferenceOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:documentReferenceOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:documentReferenceOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:documentReferenceOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:documentReferenceOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:documentReferenceOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:documentReferenceOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:documentReferenceOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:documentReferenceOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:documentReferenceOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:documentReferenceOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:documentReferenceOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:documentReferenceOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:documentReferenceOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:documentReferenceOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:documentReferenceOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:documentReferenceOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:documentReferenceOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:documentReferenceOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:documentReferenceOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:documentReferenceOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:documentReferenceOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:obsBloodGroupOut", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "obsBloodGroupOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBloodGroupOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "obsBloodGroupOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBloodGroupOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBloodGroupOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:obsBloodGroupOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:obsBloodGroupOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:obsBloodGroupOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBloodGroupOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:obsBloodGroupOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBloodGroupOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBloodGroupOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBloodGroupOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:obsBloodGroupOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:obsBloodGroupOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:obsBloodGroupOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBloodGroupOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBloodGroupOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBloodGroupOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:obsBloodGroupOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:obsBloodGroupOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsBloodGroupOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsBloodGroupOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:obsBloodGroupOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:obsBloodGroupOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:obsBloodGroupOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBloodGroupOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBloodGroupOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBloodGroupOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:obsBloodGroupOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:obsBloodGroupOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:obsBloodGroupOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:obsBloodGroupOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:obsBloodGroupOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:obsRhFactorOut", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "obsRhFactorOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsRhFactorOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "obsRhFactorOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsRhFactorOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsRhFactorOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:obsRhFactorOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:obsRhFactorOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:obsRhFactorOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsRhFactorOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:obsRhFactorOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsRhFactorOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsRhFactorOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsRhFactorOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:obsRhFactorOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:obsRhFactorOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:obsRhFactorOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsRhFactorOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsRhFactorOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsRhFactorOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:obsRhFactorOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:obsRhFactorOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsRhFactorOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsRhFactorOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:obsRhFactorOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:obsRhFactorOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:obsRhFactorOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsRhFactorOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsRhFactorOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsRhFactorOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:obsRhFactorOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:obsRhFactorOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:obsRhFactorOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:obsRhFactorOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:obsRhFactorOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:obsBodyWeightOut", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "obsBodyWeightOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBodyWeightOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "obsBodyWeightOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBodyWeightOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBodyWeightOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:obsBodyWeightOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:obsBodyWeightOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:obsBodyWeightOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBodyWeightOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:obsBodyWeightOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBodyWeightOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBodyWeightOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBodyWeightOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:obsBodyWeightOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:obsBodyWeightOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:obsBodyWeightOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBodyWeightOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBodyWeightOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBodyWeightOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:obsBodyWeightOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:obsBodyWeightOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsBodyWeightOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsBodyWeightOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:obsBodyWeightOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:obsBodyWeightOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:obsBodyWeightOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBodyWeightOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBodyWeightOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBodyWeightOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:obsBodyWeightOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:obsBodyWeightOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:obsBodyWeightOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:obsBodyWeightOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:obsBodyWeightOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:obsBodyHeightOut", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "obsBodyHeightOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBodyHeightOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "obsBodyHeightOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBodyHeightOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBodyHeightOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:obsBodyHeightOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:obsBodyHeightOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:obsBodyHeightOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBodyHeightOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:obsBodyHeightOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBodyHeightOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBodyHeightOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBodyHeightOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:obsBodyHeightOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:obsBodyHeightOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:obsBodyHeightOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBodyHeightOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBodyHeightOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBodyHeightOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:obsBodyHeightOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:obsBodyHeightOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsBodyHeightOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsBodyHeightOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:obsBodyHeightOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:obsBodyHeightOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:obsBodyHeightOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBodyHeightOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBodyHeightOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBodyHeightOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:obsBodyHeightOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:obsBodyHeightOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:obsBodyHeightOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:obsBodyHeightOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:obsBodyHeightOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:obsBMIOut", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "obsBMIOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBMIOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "obsBMIOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBMIOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBMIOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:obsBMIOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:obsBMIOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:obsBMIOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsBMIOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:obsBMIOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBMIOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBMIOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBMIOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:obsBMIOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:obsBMIOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:obsBMIOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBMIOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBMIOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBMIOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:obsBMIOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:obsBMIOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsBMIOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsBMIOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:obsBMIOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:obsBMIOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:obsBMIOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsBMIOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsBMIOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsBMIOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:obsBMIOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:obsBMIOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:obsBMIOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:obsBMIOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:obsBMIOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:serviceResquestOut", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "serviceResquestOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:serviceResquestOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "serviceResquestOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:serviceResquestOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:serviceResquestOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:serviceResquestOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:serviceResquestOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:serviceResquestOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "ServiceRequest", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ServiceRequestOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:serviceResquestOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:serviceResquestOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:serviceResquestOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:serviceResquestOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:serviceResquestOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:serviceResquestOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:serviceResquestOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:serviceResquestOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:serviceResquestOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:serviceResquestOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:serviceResquestOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:serviceResquestOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:serviceResquestOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:serviceResquestOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:serviceResquestOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:serviceResquestOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:serviceResquestOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:serviceResquestOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:serviceResquestOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:serviceResquestOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:serviceResquestOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:serviceResquestOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:serviceResquestOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:serviceResquestOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:serviceResquestOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:requestGroupOut", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "requestGroupOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:requestGroupOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "requestGroupOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:requestGroupOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:requestGroupOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:requestGroupOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:requestGroupOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:requestGroupOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "RequestGroup", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/RequestGroupOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:requestGroupOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:requestGroupOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:requestGroupOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:requestGroupOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:requestGroupOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:requestGroupOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:requestGroupOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:requestGroupOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:requestGroupOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:requestGroupOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:requestGroupOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:requestGroupOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:requestGroupOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:requestGroupOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:requestGroupOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:requestGroupOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:requestGroupOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:requestGroupOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:requestGroupOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:requestGroupOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:requestGroupOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:requestGroupOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:requestGroupOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:requestGroupOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:requestGroupOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:medicationRequestOut", "isModifier": false, "isSummary": true, "max": "*", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "medicationRequestOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:medicationRequestOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "medicationRequestOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:medicationRequestOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:medicationRequestOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:medicationRequestOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:medicationRequestOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:medicationRequestOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "MedicationRequest", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/MedicationRequestOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:medicationRequestOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:medicationRequestOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:medicationRequestOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:medicationRequestOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:medicationRequestOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:medicationRequestOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:medicationRequestOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:medicationRequestOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:medicationRequestOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:medicationRequestOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:medicationRequestOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:medicationRequestOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:medicationRequestOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:medicationRequestOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:medicationRequestOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:medicationRequestOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:medicationRequestOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:medicationRequestOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:medicationRequestOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:medicationRequestOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:medicationRequestOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:medicationRequestOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:medicationRequestOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:medicationRequestOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:medicationRequestOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:obsLastMenstrualPeriodOut", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "obsLastMenstrualPeriodOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "obsLastMenstrualPeriodOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsLastMenstrualPeriodOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsLastMenstrualPeriodOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsLastMenstrualPeriodOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsLastMenstrualPeriodOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:obsLastMenstrualPeriodOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsLastMenstrualPeriodOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsLastMenstrualPeriodOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:obsLastMenstrualPeriodOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:obsLastMenstrualPeriodOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsLastMenstrualPeriodOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:obsLastMenstrualPeriodOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:obsLastMenstrualPeriodOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:obsEDCOut", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "obsEDCOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsEDCOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "obsEDCOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsEDCOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsEDCOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:obsEDCOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:obsEDCOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:obsEDCOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsEDCOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:obsEDCOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsEDCOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsEDCOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsEDCOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:obsEDCOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:obsEDCOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:obsEDCOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsEDCOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsEDCOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsEDCOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:obsEDCOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:obsEDCOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsEDCOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsEDCOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:obsEDCOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:obsEDCOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:obsEDCOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsEDCOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsEDCOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsEDCOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:obsEDCOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:obsEDCOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:obsEDCOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:obsEDCOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:obsEDCOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:compositionOut", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "compositionOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:compositionOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "compositionOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:compositionOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:compositionOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:compositionOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:compositionOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:compositionOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Composition", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/CompositionOutpatientProgressNoteOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:compositionOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:compositionOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:compositionOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:compositionOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:compositionOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:compositionOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:compositionOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:compositionOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:compositionOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:compositionOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:compositionOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:compositionOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:compositionOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:compositionOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:compositionOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:compositionOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:compositionOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:compositionOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:compositionOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:compositionOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:compositionOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:compositionOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:compositionOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:compositionOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:compositionOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:coverageOut", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "coverageOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:coverageOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "coverageOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:coverageOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:coverageOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:coverageOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:coverageOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:coverageOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Coverage", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/CoverageOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:coverageOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:coverageOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:coverageOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:coverageOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:coverageOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:coverageOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:coverageOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:coverageOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:coverageOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:coverageOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:coverageOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:coverageOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:coverageOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:coverageOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:coverageOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:coverageOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:coverageOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:coverageOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:coverageOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:coverageOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:coverageOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:coverageOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:coverageOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:coverageOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:coverageOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:obsRecommendationToRestOut", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "obsRecommendationToRestOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsRecommendationToRestOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "obsRecommendationToRestOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsRecommendationToRestOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsRecommendationToRestOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:obsRecommendationToRestOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:obsRecommendationToRestOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:obsRecommendationToRestOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Observation", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/ObsRecommendationToRestOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:obsRecommendationToRestOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsRecommendationToRestOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsRecommendationToRestOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsRecommendationToRestOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:obsRecommendationToRestOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:obsRecommendationToRestOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:obsRecommendationToRestOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsRecommendationToRestOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsRecommendationToRestOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsRecommendationToRestOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:obsRecommendationToRestOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:obsRecommendationToRestOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsRecommendationToRestOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:obsRecommendationToRestOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:obsRecommendationToRestOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:obsRecommendationToRestOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:obsRecommendationToRestOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:obsRecommendationToRestOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:obsRecommendationToRestOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:obsRecommendationToRestOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:obsRecommendationToRestOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:obsRecommendationToRestOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:obsRecommendationToRestOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:obsRecommendationToRestOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:obsRecommendationToRestOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:compositionRecommendationOfRestOut", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "compositionRecommendationOfRestOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:compositionRecommendationOfRestOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "compositionRecommendationOfRestOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:compositionRecommendationOfRestOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:compositionRecommendationOfRestOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:compositionRecommendationOfRestOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:compositionRecommendationOfRestOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:compositionRecommendationOfRestOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Composition", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/CompositionRecommendationOfRestOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:compositionRecommendationOfRestOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:compositionRecommendationOfRestOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:compositionRecommendationOfRestOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:compositionRecommendationOfRestOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:compositionRecommendationOfRestOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:compositionRecommendationOfRestOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:compositionRecommendationOfRestOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:compositionRecommendationOfRestOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:compositionRecommendationOfRestOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:compositionRecommendationOfRestOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:compositionRecommendationOfRestOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:compositionRecommendationOfRestOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:compositionRecommendationOfRestOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:compositionRecommendationOfRestOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:compositionRecommendationOfRestOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:compositionRecommendationOfRestOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:compositionRecommendationOfRestOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:compositionRecommendationOfRestOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:compositionRecommendationOfRestOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:compositionRecommendationOfRestOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.response.status" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", "id": "Bundle.entry:compositionRecommendationOfRestOut.response.status", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.response.status", "short": "Status response code (text optional)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.location" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The location header created by processing this operation, populated if the operation returns a location.", "id": "Bundle.entry:compositionRecommendationOfRestOut.response.location", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.location", "short": "The location (if the operation returns a location)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.etag" }, "comment": "Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", "id": "Bundle.entry:compositionRecommendationOfRestOut.response.etag", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.etag", "short": "The Etag for the resource (if relevant)", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified" }, "comment": "This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The date/time that the resource was modified on the server.", "id": "Bundle.entry:compositionRecommendationOfRestOut.response.lastModified", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.lastModified", "short": "Server's date time modified", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response.outcome" }, "comment": "For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.\n\nThis outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.", "definition": "An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.", "id": "Bundle.entry:compositionRecommendationOfRestOut.response.outcome", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response.outcome", "short": "OperationOutcome with hints and warnings (for batch/transaction)", "type": [ { "code": "Resource" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry" }, "constraint": [ { "expression": "resource.exists() or request.exists() or response.exists()", "human": "must be a resource unless there's a request or response", "key": "bdl-5", "severity": "error", "xpath": "exists(f:resource) or exists(f:request) or exists(f:response)" }, { "expression": "fullUrl.contains('/_history/').not()", "human": "fullUrl cannot be a version specific reference", "key": "bdl-8", "severity": "error", "xpath": "not(exists(f:fullUrl[contains(string(@value), '/_history/')]))" }, { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "An entry resource included in the Outpatient Encounter OH resource.", "id": "Bundle.entry:accountOut", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "orderMeaning": "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", "path": "Bundle.entry", "short": "Entry resource in the Outpatient EncounterOH bundle", "sliceName": "accountOut", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:accountOut.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 1, "path": "Bundle.entry.id", "patternString": "accountOut-0", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:accountOut.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:accountOut.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "*", "min": 0, "path": "Bundle.entry.link" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "contentReference": "#Bundle.link", "definition": "A series of links that provide context to this entry.", "id": "Bundle.entry:accountOut.link", "isModifier": false, "isSummary": true, "max": "0", "min": 0, "path": "Bundle.entry.link", "short": "Links related to this entry" }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.fullUrl" }, "comment": "fullUrl might not be [unique in the context of a resource](bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.\n\nNote that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", "id": "Bundle.entry:accountOut.fullUrl", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.fullUrl", "short": "URI for resource (Absolute URL server address or URI for UUID/OID)", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.resource" }, "definition": "The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.", "id": "Bundle.entry:accountOut.resource", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.resource", "short": "A resource in the bundle", "type": [ { "code": "Account", "profile": [ "https://fhir.onehealth.com.pe/StructureDefinition/AccountOH" ] } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search" }, "condition": [ "bdl-2" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Information about the search process that lead to the creation of this entry.", "id": "Bundle.entry:accountOut.search", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search", "short": "Search related information", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:accountOut.search.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.search.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:accountOut.search.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:accountOut.search.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.search.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.mode" }, "binding": { "description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SearchEntryMode" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1" }, "comment": "There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", "id": "Bundle.entry:accountOut.search.mode", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.mode", "short": "match | include | outcome - why this is in the result set", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.search.score" }, "comment": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.\n\nSee [Patient Match](patient-operation-match.html) for the EMPI search which relates to this element.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "When searching, the server's search ranking score for the entry.", "id": "Bundle.entry:accountOut.search.score", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.search.score", "short": "Search ranking (between 0 and 1)", "type": [ { "code": "decimal" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request" }, "condition": [ "bdl-3" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.", "id": "Bundle.entry:accountOut.request", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request", "short": "Additional execution information (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:accountOut.request.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.request.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:accountOut.request.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:accountOut.request.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.request.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.method" }, "binding": { "description": "HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "HTTPVerb" } ], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/http-verb|4.0.1" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", "id": "Bundle.entry:accountOut.request.method", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.method", "short": "GET | HEAD | POST | PUT | DELETE | PATCH", "type": [ { "code": "code" } ] }, { "base": { "max": "1", "min": 1, "path": "Bundle.entry.request.url" }, "comment": "E.g. for a Patient Create, the method would be \"POST\" and the URL would be \"Patient\". For a Patient Update, the method would be PUT and the URL would be \"Patient/[id]\".", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "The URL for this entry, relative to the root (the address to which the request is posted).", "id": "Bundle.entry:accountOut.request.url", "isModifier": false, "isSummary": true, "max": "1", "min": 1, "path": "Bundle.entry.request.url", "short": "URL for HTTP equivalent of this entry", "type": [ { "code": "uri" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "If the ETag values match, return a 304 Not Modified status. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:accountOut.request.ifNoneMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneMatch", "short": "For managing cache currency", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the last updated date matches. See the API documentation for [\"Conditional Read\"](http.html#cread).", "id": "Bundle.entry:accountOut.request.ifModifiedSince", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifModifiedSince", "short": "For managing cache currency", "type": [ { "code": "instant" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Only perform the operation if the Etag value matches. For more information, see the API section [\"Managing Resource Contention\"](http.html#concurrency).", "id": "Bundle.entry:accountOut.request.ifMatch", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifMatch", "short": "For managing update contention", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist" }, "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [\"Conditional Create\"](http.html#ccreate). This is just the query portion of the URL - what follows the \"?\" (not including the \"?\").", "id": "Bundle.entry:accountOut.request.ifNoneExist", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.request.ifNoneExist", "short": "For conditional creates", "type": [ { "code": "string" } ] }, { "base": { "max": "1", "min": 0, "path": "Bundle.entry.response" }, "condition": [ "bdl-4" ], "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" } ], "definition": "Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.", "id": "Bundle.entry:accountOut.response", "isModifier": false, "isSummary": true, "max": "1", "min": 0, "path": "Bundle.entry.response", "short": "Results of execution (transaction/batch/history)", "type": [ { "code": "BackboneElement" } ] }, { "base": { "max": "1", "min": 0, "path": "Element.id" }, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "id": "Bundle.entry:accountOut.response.id", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "1", "min": 0, "path": "Bundle.entry.response.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ] }, { "alias": [ "extensions", "user content" ], "base": { "max": "*", "min": 0, "path": "Element.extension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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.", "id": "Bundle.entry:accountOut.response.extension", "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.extension", "short": "Additional content defined by implementations", "type": [ { "code": "Extension" } ] }, { "alias": [ "extensions", "user content", "modifiers" ], "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "constraint": [ { "expression": "hasValue() or (children().count() > id.count())", "human": "All FHIR elements must have a @value or children", "key": "ele-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Element", "xpath": "@value|f:*|h:div" }, { "expression": "extension.exists() != value.exists()", "human": "Must have either extensions or value[x], not both", "key": "ext-1", "severity": "error", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" } ], "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).", "id": "Bundle.entry:accountOut.response.modifierExtension", "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" } ], "max": "*", "min": 0, "path": "Bundle.entry.response.modifierExtension", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "short": "Extensions that cannot be ignored even if unrecognized", "type": [ { "code": "Extension" } ] }, { "base": { "max": "1",