{ "resourceType": "StructureDefinition", "url": "https://unicas-fhir.sanidad.gob.es/StructureDefinition/UNICASImmunization", "name": "UNICASImmunization", "title": "Immunization Inmunización ÚNICAS", "status": "draft", "description": "Este profile define las restricciones del recurso Immunization para representar el registro de una inmunización en el contexto del caso de uso de ÚNICAS.", "fhirVersion": "5.0.0", "kind": "resource", "abstract": false, "type": "Immunization", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization", "derivation": "constraint", "snapshot": { "element": [ { "id": "Immunization", "path": "Immunization", "short": "Immunization event information", "definition": "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.", "min": 0, "max": "*", "base": { "path": "Immunization", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource", "expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." } ], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" } ], "mustSupport": false, "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "Entity, Role, or Act" }, { "identity": "workflow", "map": "Event" }, { "identity": "w5", "map": "clinical.medication" }, { "identity": "v2", "map": "VXU_V04" }, { "identity": "rim", "map": "SubstanceAdministration" } ] }, { "id": "Immunization.id", "path": "Immunization.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "mustSupport": false, "isModifier": false, "isSummary": true }, { "id": "Immunization.meta", "path": "Immunization.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.implicitRules", "path": "Immunization.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.language", "path": "Immunization.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" } ], "strength": "required", "description": "IETF language tag for a human language", "valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0", "additional": [ { "purpose": "starter", "valueSet": "http://hl7.org/fhir/ValueSet/languages" } ] }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.text", "path": "Immunization.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "dom-6" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "rim", "map": "Act.text?" } ] }, { "id": "Immunization.contained", "path": "Immunization.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.extension", "path": "Immunization.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.modifierExtension", "path": "Immunization.modifierExtension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mustSupport": false, "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.identifier", "path": "Immunization.identifier", "short": "Identificador único", "definition": "Business identifier. A unique identifier assigned to this immunization record.", "comment": "The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.", "min": 1, "max": "*", "base": { "path": "Immunization.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ident-1", "severity": "warning", "human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason", "expression": "value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Identifier" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "workflow", "map": "Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": ".id" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id" } ] }, { "id": "Immunization.identifier.id", "path": "Immunization.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.identifier.extension", "path": "Immunization.identifier.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.identifier.use", "path": "Immunization.identifier.use", "short": "usual | official | temp | secondary | old (If known)", "definition": "The purpose of this identifier.", "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min": 0, "max": "1", "base": { "path": "Identifier.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "Identifies the purpose for this identifier, if known ." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "description": "Identifies the purpose for this identifier, if known .", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|5.0.0" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "id": "Immunization.identifier.type", "path": "Immunization.identifier.type", "short": "Description of identifier", "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "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.", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "min": 0, "max": "1", "base": { "path": "Identifier.type", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" } ], "strength": "extensible", "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "id": "Immunization.identifier.system", "path": "Immunization.identifier.system", "short": "Sistema para identificar el origen", "definition": "Formato: urn:regcess:[CódigoREGCESS]\r\nDebe incluir el código REGCESS después de urn:regcess:", "comment": "Identifier.system is always case sensitive.", "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.", "min": 1, "max": "1", "base": { "path": "Identifier.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "regcess-system", "severity": "warning", "human": "system debe comenzar por urn:regcess: seguido del identificador del sistema.", "expression": "matches('^urn:regcess:[A-Za-z0-9]+$')", "source": "https://unicas-fhir.sanidad.gob.es/StructureDefinition/UNICASImmunization" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ] }, { "id": "Immunization.identifier.value", "path": "Immunization.identifier.value", "short": "Identificador interno del sistema para la inmunización", "definition": "Debe indicar el ID interno del sistema de origen utilizado para la inmunización.", "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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-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.", "min": 1, "max": "1", "base": { "path": "Identifier.value", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "123456" } ], "condition": [ "ident-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.identifier.period", "path": "Immunization.identifier.period", "short": "Time period when id is/was valid for use", "definition": "Time period during which identifier is/was valid for use.", "comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).", "min": 0, "max": "1", "base": { "path": "Identifier.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "per-1", "severity": "error", "human": "If present, start SHALL have a lower or equal value than end", "expression": "start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())", "source": "http://hl7.org/fhir/StructureDefinition/Period" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR" }, { "identity": "rim", "map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]" }, { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "id": "Immunization.identifier.assigner", "path": "Immunization.identifier.assigner", "short": "Organization that issued id (may be just text)", "definition": "Organization that issued/manages the identifier.", "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.", "min": 0, "max": "1", "base": { "path": "Identifier.assigner", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "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" } ] }, { "id": "Immunization.basedOn", "path": "Immunization.basedOn", "short": "Authority that the immunization event is based on", "definition": "A plan, order or recommendation fulfilled in whole or in part by this immunization.", "comment": "Allows tracing of an authorization for the Immunization.", "min": 0, "max": "*", "base": { "path": "Immunization.basedOn", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/MedicationRequest", "http://hl7.org/fhir/StructureDefinition/ServiceRequest", "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "Event.basedOn" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.status", "path": "Immunization.status", "short": "completed | entered-in-error | not-done", "definition": "Indicates the current status of the immunization event.", "comment": "Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "base": { "path": "Immunization.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": true, "isModifierReason": "This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "A set of codes indicating the current status of an Immunization." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationStatus" } ], "strength": "required", "description": "x", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-status|5.0.0" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": "statusCode" } ] }, { "id": "Immunization.statusReason", "path": "Immunization.statusReason", "short": "Reason for current status", "definition": "Indicates the reason the immunization event was not performed.", "comment": "This is generally only used for the status of \"not-done\". The reason for performing the immunization event is captured in reasonCode, not here.", "min": 0, "max": "1", "base": { "path": "Immunization.statusReason", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "The reason why a vaccine was not administered." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationStatusReason" } ], "strength": "example", "description": "x", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-status-reason" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "workflow", "map": "Event.statusReason" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde" } ] }, { "id": "Immunization.vaccineCode", "path": "Immunization.vaccineCode", "short": "Vacuna (producto)", "definition": "Vaccine administered. Vaccine that was administered or was to be administered.", "comment": "The code for the administered vaccine may be reported at various levels of granularity from a very generic code for a general type of vaccine (e.g. the SNOMED or CVX code for the flu vaccine) to a very discrete code for a specific product including the form and packaging (e.g. an NDC code). Because vaccineCode uses the CodeableConcept data type, multiple codes at different levels of granularity may be reported for a single immunization event provided that all codes are appropriate for the same vaccine. For example, both NDC and CVX codes may be provided for a given immunization event by repeating the coding element within vaccineCode.", "min": 1, "max": "1", "base": { "path": "Immunization.vaccineCode", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "The code for vaccine product administered." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VaccineCode" } ], "strength": "extensible", "description": "Value set de Vacunas", "valueSet": "https://unicas-fhir.sanidad.gob.es/ValueSet/Vacunas" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "v2", "map": "RXA-5" }, { "identity": "rim", "map": ".code" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code" } ] }, { "id": "Immunization.vaccineCode.id", "path": "Immunization.vaccineCode.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.vaccineCode.extension", "path": "Immunization.vaccineCode.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.vaccineCode.coding", "path": "Immunization.vaccineCode.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "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.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "cod-1", "severity": "warning", "human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text", "expression": "code.exists().not() implies display.exists().not()", "source": "http://hl7.org/fhir/StructureDefinition/Coding" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "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" } ] }, { "id": "Immunization.vaccineCode.coding.id", "path": "Immunization.vaccineCode.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.vaccineCode.coding.extension", "path": "Immunization.vaccineCode.coding.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.vaccineCode.coding.system", "path": "Immunization.vaccineCode.coding.system", "short": "OID del catálogo Sistema de Información en Vacunaciones e Inmunizaciones (SIVIAN)", "definition": "Posible OID de catálogo utilizado para indicar la vacuna y su descripción correspondiente:\r\n\r\n- Catálogo de Sistema de Información en Vacunaciones e Inmunizaciones (SIVAIN): urn:oid:2.16.724.4.21.5.13", "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 be an absolute reference to some definition that establishes the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id": "Immunization.vaccineCode.coding.version", "path": "Immunization.vaccineCode.coding.version", "short": "Version of the system - if relevant", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id": "Immunization.vaccineCode.coding.code", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding", "valueBoolean": true } ], "path": "Immunization.vaccineCode.coding.code", "short": "Código de la vacuna", "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).", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Need to refer to a particular code in the system.", "min": 1, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "cod-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id": "Immunization.vaccineCode.coding.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.vaccineCode.coding.display", "short": "Descripción de la vacuna", "definition": "Representation defined by the system. A representation of the meaning of the code in the system, following the rules of the system.", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 1, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "cod-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.vaccineCode.coding.userSelected", "path": "Immunization.vaccineCode.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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 ]" } ] }, { "id": "Immunization.vaccineCode.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.vaccineCode.text", "short": "Nombre comercial de la vacuna", "definition": "Plain text representation of the concept. 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.", "comment": "Very often the text is the same as a displayName of one of the codings.", "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.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.administeredProduct", "path": "Immunization.administeredProduct", "short": "Product that was administered", "definition": "An indication of which product was administered to the patient. This is typically a more detailed representation of the concept conveyed by the vaccineCode data element. If a Medication resource is referenced, it may be to a stand-alone resource or a contained resource within the Immunization resource.", "min": 0, "max": "1", "base": { "path": "Immunization.administeredProduct", "min": 0, "max": "1" }, "type": [ { "code": "CodeableReference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Medication" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Event.code" }, { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "v2", "map": "RXA-5" }, { "identity": "rim", "map": ".code" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code" } ] }, { "id": "Immunization.manufacturer", "path": "Immunization.manufacturer", "short": "Vaccine manufacturer", "definition": "Name of vaccine manufacturer.", "min": 0, "max": "1", "base": { "path": "Immunization.manufacturer", "min": 0, "max": "1" }, "type": [ { "code": "CodeableReference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "RXA-17" }, { "identity": "rim", "map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name" } ] }, { "id": "Immunization.lotNumber", "path": "Immunization.lotNumber", "short": "Número de lote de la vacuna", "definition": "Vaccine lot number. Lot number of the vaccine product.", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "min": 0, "max": "1", "base": { "path": "Immunization.lotNumber", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "RXA-15" }, { "identity": "rim", "map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText" } ] }, { "id": "Immunization.expirationDate", "path": "Immunization.expirationDate", "short": "Fecha de caducidad", "definition": "Vaccine expiration date. Date vaccine batch expires.", "min": 0, "max": "1", "base": { "path": "Immunization.expirationDate", "min": 0, "max": "1" }, "type": [ { "code": "date" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "RXA-16" }, { "identity": "rim", "map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime" } ] }, { "id": "Immunization.patient", "path": "Immunization.patient", "short": "Referencia al paciente", "definition": "Who was immunized. The patient who either received or did not receive the immunization.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 1, "max": "1", "base": { "path": "Immunization.patient", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "https://unicas-fhir.sanidad.gob.es/StructureDefinition/UNICASPatient" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "Event.subject" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": ".partipication[ttypeCode=].role" } ] }, { "id": "Immunization.patient.id", "path": "Immunization.patient.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.patient.extension", "path": "Immunization.patient.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.patient.reference", "path": "Immunization.patient.reference", "short": "Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR", "definition": "Formato: [base]/Patient?identifier=[OID registro de número de CIP-SNS]|[Número CIP-SNS]", "comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.", "min": 0, "max": "1", "base": { "path": "Reference.reference", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-2", "ref-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.patient.type", "path": "Immunization.patient.type", "short": "Tipo de recurso FHIR", "definition": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources. The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\r\n\r\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).", "comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.", "min": 1, "max": "1", "base": { "path": "Reference.type", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "Aa resource (or, for logical models, the URI of the logical model)." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRResourceTypeExt" } ], "strength": "extensible", "description": "Aa resource (or, for logical models, the URI of the logical model).", "valueSet": "http://hl7.org/fhir/ValueSet/resource-types" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.patient.identifier", "path": "Immunization.patient.identifier", "short": "Identificador de paciente CIP-SNS. Cuando no tengamos recurso Patient, se debera informar el identificador de paciente mediante CIP-SNS", "definition": "Logical reference, when literal reference is not known. An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.", "min": 1, "max": "1", "base": { "path": "Reference.identifier", "min": 0, "max": "1" }, "type": [ { "code": "Identifier" } ], "condition": [ "ref-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ident-1", "severity": "warning", "human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason", "expression": "value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "rim", "map": ".identifier" } ] }, { "id": "Immunization.patient.identifier.id", "path": "Immunization.patient.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.patient.identifier.extension", "path": "Immunization.patient.identifier.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.patient.identifier.use", "path": "Immunization.patient.identifier.use", "short": "usual | official | temp | secondary | old (If known)", "definition": "The purpose of this identifier.", "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min": 0, "max": "1", "base": { "path": "Identifier.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "Identifies the purpose for this identifier, if known ." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "description": "Identifies the purpose for this identifier, if known .", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|5.0.0" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "id": "Immunization.patient.identifier.type", "path": "Immunization.patient.identifier.type", "short": "Tipos de documentos de identificación para persona ÚNICAS", "definition": "Description of identifier. A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "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.", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "min": 0, "max": "1", "base": { "path": "Identifier.type", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" } ], "strength": "extensible", "description": "Value set de Tipos de documentos de identificación para persona ÚNICAS", "valueSet": "https://unicas-fhir.sanidad.gob.es/ValueSet/TiposDocumentosIdentificacionPersona" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "id": "Immunization.patient.identifier.type.id", "path": "Immunization.patient.identifier.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.patient.identifier.type.extension", "path": "Immunization.patient.identifier.type.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.patient.identifier.type.coding", "path": "Immunization.patient.identifier.type.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "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.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "cod-1", "severity": "warning", "human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text", "expression": "code.exists().not() implies display.exists().not()", "source": "http://hl7.org/fhir/StructureDefinition/Coding" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "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" } ] }, { "id": "Immunization.patient.identifier.type.coding.id", "path": "Immunization.patient.identifier.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.patient.identifier.type.coding.extension", "path": "Immunization.patient.identifier.type.coding.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.patient.identifier.type.coding.system", "path": "Immunization.patient.identifier.type.coding.system", "short": "URL del SNOMED CT. Extensión para España del SNS", "definition": "Posible URL de terminología utilizada para indicar el tipo de documentos de identificación y su descripción correspondiente:\r\n\r\n- SNOMED CT. Extensión para España del SNS: http://snomed.info/sct/900000001000122104", "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 be an absolute reference to some definition that establishes the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 0, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id": "Immunization.patient.identifier.type.coding.version", "path": "Immunization.patient.identifier.type.coding.version", "short": "Version of the system - if relevant", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id": "Immunization.patient.identifier.type.coding.code", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding", "valueBoolean": true } ], "path": "Immunization.patient.identifier.type.coding.code", "short": "Código del identificador", "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).", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Need to refer to a particular code in the system.", "min": 0, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "cod-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id": "Immunization.patient.identifier.type.coding.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.patient.identifier.type.coding.display", "short": "Decripción del identificador", "definition": "Representation defined by the system. A representation of the meaning of the code in the system, following the rules of the system.", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 0, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "cod-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.patient.identifier.type.coding.userSelected", "path": "Immunization.patient.identifier.type.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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 ]" } ] }, { "id": "Immunization.patient.identifier.type.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.patient.identifier.type.text", "short": "Plain text representation of the concept", "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.", "comment": "Very often the text is the same as a displayName of one of the codings.", "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.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.patient.identifier.system", "path": "Immunization.patient.identifier.system", "short": "OID registro de número de CIP-SNS", "definition": "The namespace for the identifier value. Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.", "comment": "Identifier.system is always case sensitive.", "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.", "min": 0, "max": "1", "base": { "path": "Identifier.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ] }, { "id": "Immunization.patient.identifier.value", "path": "Immunization.patient.identifier.value", "short": "Número CIP-SNS", "definition": "The value that is unique. The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-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.", "min": 0, "max": "1", "base": { "path": "Identifier.value", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "123456" } ], "condition": [ "ident-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.patient.identifier.period", "path": "Immunization.patient.identifier.period", "short": "Time period when id is/was valid for use", "definition": "Time period during which identifier is/was valid for use.", "comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).", "min": 0, "max": "1", "base": { "path": "Identifier.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "per-1", "severity": "error", "human": "If present, start SHALL have a lower or equal value than end", "expression": "start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())", "source": "http://hl7.org/fhir/StructureDefinition/Period" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR" }, { "identity": "rim", "map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]" }, { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "id": "Immunization.patient.identifier.assigner", "path": "Immunization.patient.identifier.assigner", "short": "Organization that issued id (may be just text)", "definition": "Organization that issued/manages the identifier.", "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.", "min": 0, "max": "1", "base": { "path": "Identifier.assigner", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "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" } ] }, { "id": "Immunization.patient.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.patient.display", "short": "Nombre completo del paciente", "definition": "Text alternative for the resource. Plain text narrative that identifies the resource in addition to the resource reference.", "comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "min": 0, "max": "1", "base": { "path": "Reference.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.encounter", "path": "Immunization.encounter", "short": "Referencia a la interacción clínica", "definition": "Encounter immunization was part of. The visit or admission or other contact between patient and health care provider the immunization was performed as part of.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "1", "base": { "path": "Immunization.encounter", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "https://unicas-fhir.sanidad.gob.es/StructureDefinition/UNICASEncounter" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "Event.encounter" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "v2", "map": "PV1-19" }, { "identity": "rim", "map": "component->EncounterEvent" } ] }, { "id": "Immunization.encounter.id", "path": "Immunization.encounter.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.encounter.extension", "path": "Immunization.encounter.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.encounter.reference", "path": "Immunization.encounter.reference", "short": "Referencia recurso FHIR", "definition": "Formato: [base]/Encounter?identifier=urn:regcess:[CódigoREGCESS]|[Id interno del sistema para la interacción clínica]", "comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.", "min": 0, "max": "1", "base": { "path": "Reference.reference", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-2", "ref-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.encounter.type", "path": "Immunization.encounter.type", "short": "Tipo de recurso FHIR", "definition": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources. The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\r\n\r\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).", "comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.", "min": 0, "max": "1", "base": { "path": "Reference.type", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "Aa resource (or, for logical models, the URI of the logical model)." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRResourceTypeExt" } ], "strength": "extensible", "description": "Aa resource (or, for logical models, the URI of the logical model).", "valueSet": "http://hl7.org/fhir/ValueSet/resource-types" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.encounter.identifier", "path": "Immunization.encounter.identifier", "short": "Identificador del recurso FHIR", "definition": "Logical reference, when literal reference is not known. An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.", "min": 0, "max": "1", "base": { "path": "Reference.identifier", "min": 0, "max": "1" }, "type": [ { "code": "Identifier" } ], "condition": [ "ref-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ident-1", "severity": "warning", "human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason", "expression": "value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "rim", "map": ".identifier" } ] }, { "id": "Immunization.encounter.identifier.id", "path": "Immunization.encounter.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.encounter.identifier.extension", "path": "Immunization.encounter.identifier.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.encounter.identifier.use", "path": "Immunization.encounter.identifier.use", "short": "usual | official | temp | secondary | old (If known)", "definition": "The purpose of this identifier.", "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min": 0, "max": "1", "base": { "path": "Identifier.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "Identifies the purpose for this identifier, if known ." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "description": "Identifies the purpose for this identifier, if known .", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|5.0.0" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "id": "Immunization.encounter.identifier.type", "path": "Immunization.encounter.identifier.type", "short": "Description of identifier", "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "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.", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "min": 0, "max": "1", "base": { "path": "Identifier.type", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" } ], "strength": "extensible", "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-type" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "id": "Immunization.encounter.identifier.system", "path": "Immunization.encounter.identifier.system", "short": "Sistema para identificar el origen", "definition": "Formato: urn:regcess:[CódigoREGCESS]\r\nDebe incluir el código REGCESS después de urn:regcess:", "comment": "Identifier.system is always case sensitive.", "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.", "min": 0, "max": "1", "base": { "path": "Identifier.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ] }, { "id": "Immunization.encounter.identifier.value", "path": "Immunization.encounter.identifier.value", "short": "Identificador interno del sistema para la interacción clínica", "definition": "Debe indicar el ID interno del sistema de origen utilizado para la interacción clínica", "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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-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.", "min": 0, "max": "1", "base": { "path": "Identifier.value", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "123456" } ], "condition": [ "ident-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.encounter.identifier.period", "path": "Immunization.encounter.identifier.period", "short": "Time period when id is/was valid for use", "definition": "Time period during which identifier is/was valid for use.", "comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).", "min": 0, "max": "1", "base": { "path": "Identifier.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "per-1", "severity": "error", "human": "If present, start SHALL have a lower or equal value than end", "expression": "start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())", "source": "http://hl7.org/fhir/StructureDefinition/Period" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR" }, { "identity": "rim", "map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]" }, { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "id": "Immunization.encounter.identifier.assigner", "path": "Immunization.encounter.identifier.assigner", "short": "Organization that issued id (may be just text)", "definition": "Organization that issued/manages the identifier.", "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.", "min": 0, "max": "1", "base": { "path": "Identifier.assigner", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "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" } ] }, { "id": "Immunization.encounter.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.encounter.display", "short": "Text alternative for the resource", "definition": "Plain text narrative that identifies the resource in addition to the resource reference.", "comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "min": 0, "max": "1", "base": { "path": "Reference.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.supportingInformation", "path": "Immunization.supportingInformation", "short": "Additional information in support of the immunization", "definition": "Additional information that is relevant to the immunization (e.g. for a vaccine recipient who is pregnant, the gestational age of the fetus). The reason why a vaccine was given (e.g. occupation, underlying medical condition) should be conveyed in Immunization.reason, not as supporting information. The reason why a vaccine was not given (e.g. contraindication) should be conveyed in Immunization.statusReason, not as supporting information.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "*", "base": { "path": "Immunization.supportingInformation", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "w5", "map": "FiveWs.context" } ] }, { "id": "Immunization.occurrence[x]", "path": "Immunization.occurrence[x]", "short": "Fecha de administración", "definition": "Vaccine administration date. Date vaccine administered or was to be administered.", "comment": "When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.", "min": 1, "max": "1", "base": { "path": "Immunization.occurrence[x]", "min": 1, "max": "1" }, "type": [ { "code": "dateTime" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "v2", "map": "RXA-3" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value" } ] }, { "id": "Immunization.primarySource", "path": "Immunization.primarySource", "short": "Indicates context the data was captured in", "definition": "Indicates whether the data contained in the resource was captured by the individual/organization which was responsible for the administration of the vaccine rather than as 'secondary reported' data documented by a third party. A value of 'true' means this data originated with the individual/organization which was responsible for the administration of the vaccine.", "comment": "Reflects the “reliability” of the content.", "min": 0, "max": "1", "base": { "path": "Immunization.primarySource", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Event.reported" }, { "identity": "w5", "map": "FiveWs.source" }, { "identity": "v2", "map": "RXA-9" }, { "identity": "rim", "map": "immunization.uncertaintycode (if primary source=false, uncertainty=U)" } ] }, { "id": "Immunization.informationSource", "path": "Immunization.informationSource", "short": "Indicates the source of a reported record", "definition": "Typically the source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.", "comment": "Typically will not be populated if primarySource = True, not required even if primarySource = False.", "min": 0, "max": "1", "base": { "path": "Immunization.informationSource", "min": 0, "max": "1" }, "type": [ { "code": "CodeableReference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "The source of the data for a record which is not from a primary source." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationReportOrigin" } ], "strength": "example", "description": "x", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-origin" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Event.reported" }, { "identity": "w5", "map": "FiveWs.source" }, { "identity": "v2", "map": "RXA-9" }, { "identity": "rim", "map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)" } ] }, { "id": "Immunization.location", "path": "Immunization.location", "short": "Where immunization occurred", "definition": "The service delivery location where the vaccine administration occurred.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "1", "base": { "path": "Immunization.location", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "Event.location" }, { "identity": "w5", "map": "FiveWs.where[x]" }, { "identity": "v2", "map": "RXA-27 (or RXA-11, deprecated as of v2.7)" }, { "identity": "rim", "map": ".participation[typeCode=LOC].COCT_MT240000UV" } ] }, { "id": "Immunization.site", "path": "Immunization.site", "short": "Localización anatómica de administración", "definition": "Body site where vaccine was administered.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 0, "max": "1", "base": { "path": "Immunization.site", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "The site at which the vaccine was administered." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationSite" } ], "strength": "extensible", "description": "Value set de Localizaciones anatómicas de administración", "valueSet": "https://unicas-fhir.sanidad.gob.es/ValueSet/LocalizacionesAnatomicas" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "RXR-2" }, { "identity": "rim", "map": "observation.targetSiteCode" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code" } ] }, { "id": "Immunization.site.id", "path": "Immunization.site.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.site.extension", "path": "Immunization.site.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.site.coding", "path": "Immunization.site.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "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.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "cod-1", "severity": "warning", "human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text", "expression": "code.exists().not() implies display.exists().not()", "source": "http://hl7.org/fhir/StructureDefinition/Coding" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "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" } ] }, { "id": "Immunization.site.coding.id", "path": "Immunization.site.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.site.coding.extension", "path": "Immunization.site.coding.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.site.coding.system", "path": "Immunization.site.coding.system", "short": "OID del catálogo Sistema de Información en Vacunaciones e Inmunizaciones (SIVIAN)", "definition": "Posible OID de catálogo utilizado para indicar la localización anatómica de administración y su descripción correspondiente:\r\n\r\n- Catálogo de Sistema de Información en Vacunaciones e Inmunizaciones (SIVAIN): urn:oid:2.16.724.4.21.5.13", "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 be an absolute reference to some definition that establishes the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 0, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id": "Immunization.site.coding.version", "path": "Immunization.site.coding.version", "short": "Version of the system - if relevant", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id": "Immunization.site.coding.code", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding", "valueBoolean": true } ], "path": "Immunization.site.coding.code", "short": "Código del localización anatómica de administración", "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).", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Need to refer to a particular code in the system.", "min": 0, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "cod-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id": "Immunization.site.coding.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.site.coding.display", "short": "Descripción del localización anatómica de administración", "definition": "Representation defined by the system. A representation of the meaning of the code in the system, following the rules of the system.", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 0, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "cod-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.site.coding.userSelected", "path": "Immunization.site.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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 ]" } ] }, { "id": "Immunization.site.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.site.text", "short": "Plain text representation of the concept", "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.", "comment": "Very often the text is the same as a displayName of one of the codings.", "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.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.route", "path": "Immunization.route", "short": "Vía de administración", "definition": "How vaccine entered body. The path by which the vaccine product is taken into the body.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 0, "max": "1", "base": { "path": "Immunization.route", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "The route by which the vaccine was administered." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationRoute" } ], "strength": "extensible", "description": "Value set de Vias de administración vacunación", "valueSet": "https://unicas-fhir.sanidad.gob.es/ValueSet/ViasAdministracionVacunacion" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "RXR-1" }, { "identity": "rim", "map": ".routeCode" }, { "identity": "cda", "map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code" } ] }, { "id": "Immunization.route.id", "path": "Immunization.route.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.route.extension", "path": "Immunization.route.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.route.coding", "path": "Immunization.route.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "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.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "cod-1", "severity": "warning", "human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text", "expression": "code.exists().not() implies display.exists().not()", "source": "http://hl7.org/fhir/StructureDefinition/Coding" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "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" } ] }, { "id": "Immunization.route.coding.id", "path": "Immunization.route.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.route.coding.extension", "path": "Immunization.route.coding.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.route.coding.system", "path": "Immunization.route.coding.system", "short": "OID del catálogo Sistema de Información en Vacunaciones e Inmunizaciones (SIVIAN)", "definition": "Posible OID de catálogo utilizado para indicar la vía de administración y su descripción correspondiente:\r\n\r\n- Catálogo de Sistema de Información en Vacunaciones e Inmunizaciones (SIVAIN): urn:oid:2.16.724.4.21.5.13", "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 be an absolute reference to some definition that establishes the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 0, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id": "Immunization.route.coding.version", "path": "Immunization.route.coding.version", "short": "Version of the system - if relevant", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id": "Immunization.route.coding.code", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding", "valueBoolean": true } ], "path": "Immunization.route.coding.code", "short": "Código de la vía de administración", "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).", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Need to refer to a particular code in the system.", "min": 0, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "cod-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id": "Immunization.route.coding.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.route.coding.display", "short": "Descripción de la vía de administración", "definition": "Representation defined by the system. A representation of the meaning of the code in the system, following the rules of the system.", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 0, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "cod-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.route.coding.userSelected", "path": "Immunization.route.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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 ]" } ] }, { "id": "Immunization.route.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.route.text", "short": "Plain text representation of the concept", "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.", "comment": "Very often the text is the same as a displayName of one of the codings.", "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.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.doseQuantity", "path": "Immunization.doseQuantity", "short": "Dosis administrada", "definition": "Amount of vaccine administered. The quantity of vaccine product that was administered.", "comment": "The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.", "min": 1, "max": "1", "base": { "path": "Immunization.doseQuantity", "min": 0, "max": "1" }, "type": [ { "code": "Quantity", "profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "qty-3", "severity": "error", "human": "If a code for the unit is present, the system SHALL also be present", "expression": "code.empty() or system.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Quantity" }, { "key": "sqty-1", "severity": "error", "human": "The comparator is not used on a SimpleQuantity", "expression": "comparator.empty()", "source": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "SN (see also Range) or CQ" }, { "identity": "rim", "map": "PQ, IVL, MO, CO, depending on the values" }, { "identity": "v2", "map": "RXA-6 / RXA-7" }, { "identity": "rim", "map": ".doseQuantity" } ] }, { "id": "Immunization.doseQuantity.id", "path": "Immunization.doseQuantity.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.doseQuantity.extension", "path": "Immunization.doseQuantity.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.doseQuantity.value", "path": "Immunization.doseQuantity.value", "short": "Número de dosis", "definition": "Numerical value (with implicit precision). The value of the measured amount. The value includes an implicit precision in the presentation of the 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).", "requirements": "Precision is handled implicitly in almost all cases of measurement.", "min": 0, "max": "1", "base": { "path": "Quantity.value", "min": 0, "max": "1" }, "type": [ { "code": "decimal" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.doseQuantity.comparator", "path": "Immunization.doseQuantity.comparator", "short": "< | <= | >= | > | ad - how to understand the value", "definition": "Not allowed to be used in this context", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.", "min": 0, "max": "0", "base": { "path": "Quantity.comparator", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "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, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "How the Quantity should be understood and represented." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuantityComparator" } ], "strength": "required", "description": "How the Quantity should be understood and represented.", "valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "SN.1 / CQ.1" }, { "identity": "rim", "map": "IVL properties" } ] }, { "id": "Immunization.doseQuantity.unit", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.doseQuantity.unit", "short": "Unidad de dosis", "definition": "Unit representation. A human-readable form of the unit.", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.", "min": 0, "max": "1", "base": { "path": "Quantity.unit", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.unit" } ] }, { "id": "Immunization.doseQuantity.system", "path": "Immunization.doseQuantity.system", "short": "URL del catálogo UCUM", "definition": "- Unified Code for Units of Measure (UCUM): http://unitsofmeasure.org", "comment": "see http://en.wikipedia.org/wiki/Uniform_resource_identifier", "requirements": "Need to know the system that defines the coded form of the unit.", "min": 0, "max": "1", "base": { "path": "Quantity.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "condition": [ "qty-3" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "CO.codeSystem, PQ.translation.codeSystem" } ] }, { "id": "Immunization.doseQuantity.code", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding", "valueBoolean": true } ], "path": "Immunization.doseQuantity.code", "short": "Código de la unidad de la dosis", "definition": "Coded form of the unit. A computer processable form of the unit in some unit representation system.", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Quantity.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "qty-3" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "(see OBX.6 etc.) / CQ.2" }, { "identity": "rim", "map": "PQ.code, MO.currency, PQ.translation.code" } ] }, { "id": "Immunization.performer", "path": "Immunization.performer", "short": "Profesional sanitario", "definition": "Who performed event. Indicates who performed the immunization event.", "min": 1, "max": "*", "base": { "path": "Immunization.performer", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Event.performer" }, { "identity": "v2", "map": "ORC-12 / RXA-10" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]" } ] }, { "id": "Immunization.performer.id", "path": "Immunization.performer.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.performer.extension", "path": "Immunization.performer.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.performer.modifierExtension", "path": "Immunization.performer.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.performer.function", "path": "Immunization.performer.function", "short": "What type of performance was done", "definition": "Describes the type of performance (e.g. ordering provider, administering provider, etc.).", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 0, "max": "1", "base": { "path": "Immunization.performer.function", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "The role a practitioner or organization plays in the immunization event." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationFunction" } ], "strength": "extensible", "description": "x", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-function" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "workflow", "map": "Event.performer.function" }, { "identity": "rim", "map": ".participation.functionCode" } ] }, { "id": "Immunization.performer.actor", "path": "Immunization.performer.actor", "short": "Referencia al profesional sanitario", "definition": "Individual or organization who was performing. The practitioner or organization who performed the action.", "comment": "When the individual practitioner who performed the action is known, it is best to send.", "min": 1, "max": "1", "base": { "path": "Immunization.performer.actor", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "https://unicas-fhir.sanidad.gob.es/StructureDefinition/UNICASPractitionerRole", "https://unicas-fhir.sanidad.gob.es/StructureDefinition/UNICASPractitioner", "https://unicas-fhir.sanidad.gob.es/StructureDefinition/UNICASOrganization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "Event.performer.actor" }, { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "rim", "map": ".player" } ] }, { "id": "Immunization.performer.actor.id", "path": "Immunization.performer.actor.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.performer.actor.extension", "path": "Immunization.performer.actor.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.performer.actor.reference", "path": "Immunization.performer.actor.reference", "short": "Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR", "definition": "Formato: [base]/Practitioner?identifier=[OID registro de DNI]|[Número DNI]", "comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.", "min": 0, "max": "1", "base": { "path": "Reference.reference", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-2", "ref-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.performer.actor.type", "path": "Immunization.performer.actor.type", "short": "Tipo de recurso FHIR", "definition": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources. The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).", "comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.", "min": 1, "max": "1", "base": { "path": "Reference.type", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "Aa resource (or, for logical models, the URI of the logical model)." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRResourceTypeExt" } ], "strength": "extensible", "description": "Aa resource (or, for logical models, the URI of the logical model).", "valueSet": "http://hl7.org/fhir/ValueSet/resource-types" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.performer.actor.identifier", "path": "Immunization.performer.actor.identifier", "short": "Identificadores del profesional sanitario. Cuando no tengamos recurso Practitioner, se debera informar el identificador del profesional sanitario mediante DNI como dato mínimo. Adicionalmente, se puede informar el número colegiado del profesional sanitario como dato recomendado", "definition": "Logical reference, when literal reference is not known. An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.", "min": 1, "max": "1", "base": { "path": "Reference.identifier", "min": 0, "max": "1" }, "type": [ { "code": "Identifier" } ], "condition": [ "ref-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ident-1", "severity": "warning", "human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason", "expression": "value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Identifier" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "rim", "map": ".identifier" } ] }, { "id": "Immunization.performer.actor.identifier.id", "path": "Immunization.performer.actor.identifier.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.performer.actor.identifier.extension", "path": "Immunization.performer.actor.identifier.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.performer.actor.identifier.extension:numeroColegiadoProfesionalSanitario", "path": "Immunization.performer.actor.identifier.extension", "sliceName": "numeroColegiadoProfesionalSanitario", "short": "Número de colegiado del profesional sanitario", "definition": "Número de colegiado del profesional sanitario", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "https://unicas-fhir.sanidad.gob.es/StructureDefinition/NumeroColegiadoProfesionalSanitario" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.performer.actor.identifier.use", "path": "Immunization.performer.actor.identifier.use", "short": "usual | official | temp | secondary | old (If known)", "definition": "The purpose of this identifier.", "comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min": 0, "max": "1", "base": { "path": "Identifier.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "Identifies the purpose for this identifier, if known ." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "strength": "required", "description": "Identifies the purpose for this identifier, if known .", "valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|5.0.0" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "id": "Immunization.performer.actor.identifier.type", "path": "Immunization.performer.actor.identifier.type", "short": "Tipos de documentos de identificación para persona ÚNICAS", "definition": "Description of identifier. A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "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.", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "min": 0, "max": "1", "base": { "path": "Identifier.type", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" } ], "strength": "extensible", "description": "Value set de Tipos de documentos de identificación para persona ÚNICAS", "valueSet": "https://unicas-fhir.sanidad.gob.es/ValueSet/TiposDocumentosIdentificacionPersona" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "id": "Immunization.performer.actor.identifier.type.id", "path": "Immunization.performer.actor.identifier.type.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.performer.actor.identifier.type.extension", "path": "Immunization.performer.actor.identifier.type.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.performer.actor.identifier.type.coding", "path": "Immunization.performer.actor.identifier.type.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "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.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "cod-1", "severity": "warning", "human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text", "expression": "code.exists().not() implies display.exists().not()", "source": "http://hl7.org/fhir/StructureDefinition/Coding" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "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" } ] }, { "id": "Immunization.performer.actor.identifier.type.coding.id", "path": "Immunization.performer.actor.identifier.type.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.performer.actor.identifier.type.coding.extension", "path": "Immunization.performer.actor.identifier.type.coding.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.performer.actor.identifier.type.coding.system", "path": "Immunization.performer.actor.identifier.type.coding.system", "short": "URL del refset Tipos de documento para identificación personal de SNOMED CT. Extensión para España del SNS", "definition": "Posible URL de terminología utilizada para indicar el tipo de documentos de identificación y su descripción correspondiente:\r\n\r\n- Refset Tipos de documento para identificación personal del SNOMED CT. Extensión para España del SNS: http://snomed.info/sct/900000001000122104?fhir_vs-refset/900000251000122107", "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 be an absolute reference to some definition that establishes the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 0, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id": "Immunization.performer.actor.identifier.type.coding.version", "path": "Immunization.performer.actor.identifier.type.coding.version", "short": "Version of the system - if relevant", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id": "Immunization.performer.actor.identifier.type.coding.code", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding", "valueBoolean": true } ], "path": "Immunization.performer.actor.identifier.type.coding.code", "short": "Código del identificador", "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).", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Need to refer to a particular code in the system.", "min": 0, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "cod-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id": "Immunization.performer.actor.identifier.type.coding.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.performer.actor.identifier.type.coding.display", "short": "Decripción del identificador", "definition": "Representation defined by the system. A representation of the meaning of the code in the system, following the rules of the system.", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 0, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "cod-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.performer.actor.identifier.type.coding.userSelected", "path": "Immunization.performer.actor.identifier.type.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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 ]" } ] }, { "id": "Immunization.performer.actor.identifier.type.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.performer.actor.identifier.type.text", "short": "Plain text representation of the concept", "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.", "comment": "Very often the text is the same as a displayName of one of the codings.", "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.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.performer.actor.identifier.system", "path": "Immunization.performer.actor.identifier.system", "short": "OID registro de DNI", "definition": "The namespace for the identifier value. Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.", "comment": "Identifier.system is always case sensitive.", "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.", "min": 0, "max": "1", "base": { "path": "Identifier.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ] }, { "id": "Immunization.performer.actor.identifier.value", "path": "Immunization.performer.actor.identifier.value", "short": "Número del DNI", "definition": "The value that is unique. The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "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 [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-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.", "min": 0, "max": "1", "base": { "path": "Identifier.value", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "example": [ { "label": "General", "valueString": "123456" } ], "condition": [ "ident-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.performer.actor.identifier.period", "path": "Immunization.performer.actor.identifier.period", "short": "Time period when id is/was valid for use", "definition": "Time period during which identifier is/was valid for use.", "comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).", "min": 0, "max": "1", "base": { "path": "Identifier.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "per-1", "severity": "error", "human": "If present, start SHALL have a lower or equal value than end", "expression": "start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())", "source": "http://hl7.org/fhir/StructureDefinition/Period" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR" }, { "identity": "rim", "map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]" }, { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "id": "Immunization.performer.actor.identifier.assigner", "path": "Immunization.performer.actor.identifier.assigner", "short": "Organization that issued id (may be just text)", "definition": "Organization that issued/manages the identifier.", "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.", "min": 0, "max": "1", "base": { "path": "Identifier.assigner", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "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" } ] }, { "id": "Immunization.performer.actor.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.performer.actor.display", "short": "Nombre completo del profesional sanitario", "definition": "Text alternative for the resource. Plain text narrative that identifies the resource in addition to the resource reference.", "comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "min": 0, "max": "1", "base": { "path": "Reference.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-2" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.note", "path": "Immunization.note", "short": "Additional immunization notes", "definition": "Extra information about the immunization that is not conveyed by the other attributes.", "comment": "For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. *Annotations SHOULD NOT* be used to communicate \"modifying\" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).", "min": 0, "max": "*", "base": { "path": "Immunization.note", "min": 0, "max": "*" }, "type": [ { "code": "Annotation" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Act" }, { "identity": "workflow", "map": "Event.note" }, { "identity": "v2", "map": "OBX-5 : OBX-3 = 48767-8" }, { "identity": "rim", "map": "note" } ] }, { "id": "Immunization.reason", "path": "Immunization.reason", "short": "Motivo de la vacunación", "definition": "Why immunization occurred. Describes why the immunization occurred in coded or textual form, or Indicates another resource (Condition, Observation or DiagnosticReport) whose existence justifies this immunization.", "min": 1, "max": "*", "base": { "path": "Immunization.reason", "min": 0, "max": "*" }, "type": [ { "code": "CodeableReference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "The reason why a vaccine was administered." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationReason" } ], "strength": "extensible", "description": "Value set de Motivos de vacunación", "valueSet": "https://unicas-fhir.sanidad.gob.es/ValueSet/MotivosVacunacion" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Event.reason" }, { "identity": "rim", "map": "[actionNegationInd=false].reasonCode" } ] }, { "id": "Immunization.reason.id", "path": "Immunization.reason.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.reason.extension", "path": "Immunization.reason.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.reason.concept", "path": "Immunization.reason.concept", "short": "Motivo de la vacunación", "definition": "Reference to a concept (by class). A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 0, "max": "1", "base": { "path": "CodeableReference.concept", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.reason.concept.id", "path": "Immunization.reason.concept.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.reason.concept.extension", "path": "Immunization.reason.concept.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.reason.concept.coding", "path": "Immunization.reason.concept.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "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.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "cod-1", "severity": "warning", "human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text", "expression": "code.exists().not() implies display.exists().not()", "source": "http://hl7.org/fhir/StructureDefinition/Coding" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "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" } ] }, { "id": "Immunization.reason.concept.coding.id", "path": "Immunization.reason.concept.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.reason.concept.coding.extension", "path": "Immunization.reason.concept.coding.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.reason.concept.coding.system", "path": "Immunization.reason.concept.coding.system", "short": "OID del catálogo Sistema de Información en Vacunaciones e Inmunizaciones (SIVIAN)", "definition": "Posible OID de catálogo utilizado para indicar el motivo de la vacunación y su descripción correspondiente:\r\n\r\n- Catálogo de Sistema de Información en Vacunaciones e Inmunizaciones (SIVAIN): urn:oid:2.16.724.4.21.5.13", "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 be an absolute reference to some definition that establishes the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id": "Immunization.reason.concept.coding.version", "path": "Immunization.reason.concept.coding.version", "short": "Version of the system - if relevant", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id": "Immunization.reason.concept.coding.code", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding", "valueBoolean": true } ], "path": "Immunization.reason.concept.coding.code", "short": "Código del motivo de la vacunación", "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).", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Need to refer to a particular code in the system.", "min": 1, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "cod-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id": "Immunization.reason.concept.coding.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.reason.concept.coding.display", "short": "Descripción del motivo de la vacunación", "definition": "Representation defined by the system. A representation of the meaning of the code in the system, following the rules of the system.", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 1, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "cod-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.reason.concept.coding.userSelected", "path": "Immunization.reason.concept.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "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.", "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.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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 ]" } ] }, { "id": "Immunization.reason.concept.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.reason.concept.text", "short": "Plain text representation of the concept", "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.", "comment": "Very often the text is the same as a displayName of one of the codings.", "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.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "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" } ] }, { "id": "Immunization.reason.reference", "path": "Immunization.reason.reference", "short": "Reference to a resource (by instance)", "definition": "A reference to a resource the provides exact details about the information being referenced.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "1", "base": { "path": "CodeableReference.reference", "min": 0, "max": "1" }, "type": [ { "code": "Reference" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.isSubpotent", "path": "Immunization.isSubpotent", "short": "Dose potency", "definition": "Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.", "comment": "Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.", "min": 0, "max": "1", "base": { "path": "Immunization.isSubpotent", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "meaningWhenMissing": "By default, a dose should be considered to be potent.", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": true, "isModifierReason": "This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose.", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "RXA-20 = PA (partial administration)" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.subpotentReason", "path": "Immunization.subpotentReason", "short": "Reason for being subpotent", "definition": "Reason why a dose is considered to be subpotent.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 0, "max": "*", "base": { "path": "Immunization.subpotentReason", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SubpotentReason" } ], "strength": "example", "description": "The reason why a dose is considered to be subpotent.", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-subpotent-reason" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.programEligibility", "path": "Immunization.programEligibility", "short": "Patient eligibility for a specific vaccination program", "definition": "Indicates a patient's eligibility for a funding program.", "min": 0, "max": "*", "base": { "path": "Immunization.programEligibility", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "OBX-5 : OBX-3 = 64994-7" } ] }, { "id": "Immunization.programEligibility.id", "path": "Immunization.programEligibility.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.programEligibility.extension", "path": "Immunization.programEligibility.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.programEligibility.modifierExtension", "path": "Immunization.programEligibility.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.programEligibility.program", "path": "Immunization.programEligibility.program", "short": "The program that eligibility is declared for", "definition": "Indicates which program the patient had their eligility evaluated for.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 1, "max": "1", "base": { "path": "Immunization.programEligibility.program", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "The vaccation funding program a patient may be eligible for." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VaccineFundingProgram" } ], "strength": "example", "description": "x", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-vaccine-funding-program" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" } ] }, { "id": "Immunization.programEligibility.programStatus", "path": "Immunization.programEligibility.programStatus", "short": "The patient's eligibility status for the program", "definition": "Indicates the patient's eligility status for for a specific payment program.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 1, "max": "1", "base": { "path": "Immunization.programEligibility.programStatus", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "The patient's eligibility for a vaccation program." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProgramEligibility" } ], "strength": "example", "description": "x", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-program-eligibility" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" } ] }, { "id": "Immunization.fundingSource", "path": "Immunization.fundingSource", "short": "Funding source for the vaccine", "definition": "Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 0, "max": "1", "base": { "path": "Immunization.fundingSource", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "The source of funding used to purchase the vaccine administered." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FundingSource" } ], "strength": "example", "description": "x", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-funding-source" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.reaction", "path": "Immunization.reaction", "short": "Details of a reaction that follows immunization", "definition": "Categorical data indicating that an adverse event is associated in time to an immunization.", "comment": "A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.", "min": 0, "max": "*", "base": { "path": "Immunization.reaction", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "OBX-3" }, { "identity": "rim", "map": "Observation[classCode=obs].code" } ] }, { "id": "Immunization.reaction.id", "path": "Immunization.reaction.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.reaction.extension", "path": "Immunization.reaction.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.reaction.modifierExtension", "path": "Immunization.reaction.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.reaction.date", "path": "Immunization.reaction.date", "short": "When reaction started", "definition": "Date of reaction to the immunization.", "comment": "UTC offset is allowed for dates and partial dates", "min": 0, "max": "1", "base": { "path": "Immunization.reaction.date", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 V2 VXU message - most likely would appear in OBX segments if at all)" }, { "identity": "rim", "map": ".effectiveTime" } ] }, { "id": "Immunization.reaction.manifestation", "path": "Immunization.reaction.manifestation", "short": "Additional information on reaction", "definition": "Details of the reaction.", "min": 0, "max": "1", "base": { "path": "Immunization.reaction.manifestation", "min": 0, "max": "1" }, "type": [ { "code": "CodeableReference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "OBX-5" }, { "identity": "rim", "map": ".value" } ] }, { "id": "Immunization.reaction.reported", "path": "Immunization.reaction.reported", "short": "Indicates self-reported reaction", "definition": "Self-reported indicator.", "min": 0, "max": "1", "base": { "path": "Immunization.reaction.reported", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "(HL7 V2 doesn't seem to provide for this)" }, { "identity": "rim", "map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)" } ] }, { "id": "Immunization.protocolApplied", "path": "Immunization.protocolApplied", "short": "Protocol followed by the provider", "definition": "The protocol (set of recommendations) being followed by the provider who administered the dose.", "min": 0, "max": "*", "base": { "path": "Immunization.protocolApplied", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.protocolApplied.id", "path": "Immunization.protocolApplied.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "condition": [ "ele-1" ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Immunization.protocolApplied.extension", "path": "Immunization.protocolApplied.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.protocolApplied.modifierExtension", "path": "Immunization.protocolApplied.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.protocolApplied.series", "path": "Immunization.protocolApplied.series", "short": "Name of vaccine series", "definition": "One possible path to achieve presumed immunity against a disease - within the context of an authority.", "comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size", "min": 0, "max": "1", "base": { "path": "Immunization.protocolApplied.series", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.protocolApplied.authority", "path": "Immunization.protocolApplied.authority", "short": "Who is responsible for publishing the recommendations", "definition": "Indicates the authority who published the protocol (e.g. ACIP) that is being followed.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "1", "base": { "path": "Immunization.protocolApplied.authority", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))", "source": "http://hl7.org/fhir/StructureDefinition/Reference" }, { "key": "ref-2", "severity": "error", "human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).", "expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.protocolApplied.targetDisease", "path": "Immunization.protocolApplied.targetDisease", "short": "Vaccine preventatable disease being targeted", "definition": "The vaccine preventable disease the dose is being administered against.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "min": 0, "max": "*", "base": { "path": "Immunization.protocolApplied.targetDisease", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition", "valueString": "The vaccine preventable disease the dose is being administered for." }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TargetDisease" } ], "strength": "example", "description": "x", "valueSet": "http://hl7.org/fhir/ValueSet/immunization-target-disease" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.protocolApplied.doseNumber", "path": "Immunization.protocolApplied.doseNumber", "short": "Dose number within series", "definition": "Nominal position in a series as intended by the practitioner administering the dose.", "comment": "The use of an integer is preferred if known. Text should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).", "min": 1, "max": "1", "base": { "path": "Immunization.protocolApplied.doseNumber", "min": 1, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Immunization.protocolApplied.seriesDoses", "path": "Immunization.protocolApplied.seriesDoses", "short": "Recommended number of doses for immunity", "definition": "The recommended number of doses to achieve immunity as intended by the practitioner administering the dose.", "comment": "The use of an integer is preferred if known.", "min": 0, "max": "1", "base": { "path": "Immunization.protocolApplied.seriesDoses", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": false, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] } ] }, "differential": { "element": [ { "id": "Immunization.identifier", "path": "Immunization.identifier", "short": "Identificador único", "definition": "Business identifier. A unique identifier assigned to this immunization record.", "min": 1 }, { "id": "Immunization.identifier.system", "path": "Immunization.identifier.system", "short": "Sistema para identificar el origen", "definition": "Formato: urn:regcess:[CódigoREGCESS]\r\nDebe incluir el código REGCESS después de urn:regcess:", "min": 1, "constraint": [ { "key": "regcess-system", "severity": "warning", "human": "system debe comenzar por urn:regcess: seguido del identificador del sistema.", "expression": "matches('^urn:regcess:[A-Za-z0-9]+$')" } ] }, { "id": "Immunization.identifier.value", "path": "Immunization.identifier.value", "short": "Identificador interno del sistema para la inmunización", "definition": "Debe indicar el ID interno del sistema de origen utilizado para la inmunización.", "min": 1 }, { "id": "Immunization.vaccineCode", "path": "Immunization.vaccineCode", "short": "Vacuna (producto)", "definition": "Vaccine administered. Vaccine that was administered or was to be administered.", "binding": { "strength": "extensible", "description": "Value set de Vacunas", "valueSet": "https://unicas-fhir.sanidad.gob.es/ValueSet/Vacunas" } }, { "id": "Immunization.vaccineCode.coding.system", "path": "Immunization.vaccineCode.coding.system", "short": "OID del catálogo Sistema de Información en Vacunaciones e Inmunizaciones (SIVIAN)", "definition": "Posible OID de catálogo utilizado para indicar la vacuna y su descripción correspondiente:\r\n\r\n- Catálogo de Sistema de Información en Vacunaciones e Inmunizaciones (SIVAIN): urn:oid:2.16.724.4.21.5.13", "min": 1 }, { "id": "Immunization.vaccineCode.coding.code", "path": "Immunization.vaccineCode.coding.code", "short": "Código de la vacuna", "min": 1 }, { "id": "Immunization.vaccineCode.coding.display", "path": "Immunization.vaccineCode.coding.display", "short": "Descripción de la vacuna", "definition": "Representation defined by the system. A representation of the meaning of the code in the system, following the rules of the system.", "min": 1 }, { "id": "Immunization.vaccineCode.text", "path": "Immunization.vaccineCode.text", "short": "Nombre comercial de la vacuna", "definition": "Plain text representation of the concept. 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." }, { "id": "Immunization.lotNumber", "path": "Immunization.lotNumber", "short": "Número de lote de la vacuna", "definition": "Vaccine lot number. Lot number of the vaccine product." }, { "id": "Immunization.expirationDate", "path": "Immunization.expirationDate", "short": "Fecha de caducidad", "definition": "Vaccine expiration date. Date vaccine batch expires." }, { "id": "Immunization.patient", "path": "Immunization.patient", "short": "Referencia al paciente", "definition": "Who was immunized. The patient who either received or did not receive the immunization.", "type": [ { "code": "Reference", "targetProfile": [ "https://unicas-fhir.sanidad.gob.es/StructureDefinition/UNICASPatient" ] } ] }, { "id": "Immunization.patient.reference", "path": "Immunization.patient.reference", "short": "Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR", "definition": "Formato: [base]/Patient?identifier=[OID registro de número de CIP-SNS]|[Número CIP-SNS]" }, { "id": "Immunization.patient.type", "path": "Immunization.patient.type", "short": "Tipo de recurso FHIR", "definition": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources. The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\r\n\r\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).", "min": 1 }, { "id": "Immunization.patient.identifier", "path": "Immunization.patient.identifier", "short": "Identificador de paciente CIP-SNS. Cuando no tengamos recurso Patient, se debera informar el identificador de paciente mediante CIP-SNS", "definition": "Logical reference, when literal reference is not known. An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "min": 1 }, { "id": "Immunization.patient.identifier.type", "path": "Immunization.patient.identifier.type", "short": "Tipos de documentos de identificación para persona ÚNICAS", "definition": "Description of identifier. A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "binding": { "strength": "extensible", "description": "Value set de Tipos de documentos de identificación para persona ÚNICAS", "valueSet": "https://unicas-fhir.sanidad.gob.es/ValueSet/TiposDocumentosIdentificacionPersona" } }, { "id": "Immunization.patient.identifier.type.coding.system", "path": "Immunization.patient.identifier.type.coding.system", "short": "URL del SNOMED CT. Extensión para España del SNS", "definition": "Posible URL de terminología utilizada para indicar el tipo de documentos de identificación y su descripción correspondiente:\r\n\r\n- SNOMED CT. Extensión para España del SNS: http://snomed.info/sct/900000001000122104" }, { "id": "Immunization.patient.identifier.type.coding.code", "path": "Immunization.patient.identifier.type.coding.code", "short": "Código del identificador" }, { "id": "Immunization.patient.identifier.type.coding.display", "path": "Immunization.patient.identifier.type.coding.display", "short": "Decripción del identificador", "definition": "Representation defined by the system. A representation of the meaning of the code in the system, following the rules of the system." }, { "id": "Immunization.patient.identifier.system", "path": "Immunization.patient.identifier.system", "short": "OID registro de número de CIP-SNS", "definition": "The namespace for the identifier value. Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique." }, { "id": "Immunization.patient.identifier.value", "path": "Immunization.patient.identifier.value", "short": "Número CIP-SNS", "definition": "The value that is unique. The portion of the identifier typically relevant to the user and which is unique within the context of the system." }, { "id": "Immunization.patient.display", "path": "Immunization.patient.display", "short": "Nombre completo del paciente", "definition": "Text alternative for the resource. Plain text narrative that identifies the resource in addition to the resource reference." }, { "id": "Immunization.encounter", "path": "Immunization.encounter", "short": "Referencia a la interacción clínica", "definition": "Encounter immunization was part of. The visit or admission or other contact between patient and health care provider the immunization was performed as part of.", "type": [ { "code": "Reference", "targetProfile": [ "https://unicas-fhir.sanidad.gob.es/StructureDefinition/UNICASEncounter" ] } ] }, { "id": "Immunization.encounter.reference", "path": "Immunization.encounter.reference", "short": "Referencia recurso FHIR", "definition": "Formato: [base]/Encounter?identifier=urn:regcess:[CódigoREGCESS]|[Id interno del sistema para la interacción clínica]" }, { "id": "Immunization.encounter.type", "path": "Immunization.encounter.type", "short": "Tipo de recurso FHIR", "definition": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources. The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\r\n\r\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources)." }, { "id": "Immunization.encounter.identifier", "path": "Immunization.encounter.identifier", "short": "Identificador del recurso FHIR", "definition": "Logical reference, when literal reference is not known. An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference." }, { "id": "Immunization.encounter.identifier.system", "path": "Immunization.encounter.identifier.system", "short": "Sistema para identificar el origen", "definition": "Formato: urn:regcess:[CódigoREGCESS]\r\nDebe incluir el código REGCESS después de urn:regcess:" }, { "id": "Immunization.encounter.identifier.value", "path": "Immunization.encounter.identifier.value", "short": "Identificador interno del sistema para la interacción clínica", "definition": "Debe indicar el ID interno del sistema de origen utilizado para la interacción clínica" }, { "id": "Immunization.occurrence[x]", "path": "Immunization.occurrence[x]", "short": "Fecha de administración", "definition": "Vaccine administration date. Date vaccine administered or was to be administered.", "type": [ { "code": "dateTime" } ] }, { "id": "Immunization.site", "path": "Immunization.site", "short": "Localización anatómica de administración", "binding": { "strength": "extensible", "description": "Value set de Localizaciones anatómicas de administración", "valueSet": "https://unicas-fhir.sanidad.gob.es/ValueSet/LocalizacionesAnatomicas" } }, { "id": "Immunization.site.coding.system", "path": "Immunization.site.coding.system", "short": "OID del catálogo Sistema de Información en Vacunaciones e Inmunizaciones (SIVIAN)", "definition": "Posible OID de catálogo utilizado para indicar la localización anatómica de administración y su descripción correspondiente:\r\n\r\n- Catálogo de Sistema de Información en Vacunaciones e Inmunizaciones (SIVAIN): urn:oid:2.16.724.4.21.5.13" }, { "id": "Immunization.site.coding.code", "path": "Immunization.site.coding.code", "short": "Código del localización anatómica de administración" }, { "id": "Immunization.site.coding.display", "path": "Immunization.site.coding.display", "short": "Descripción del localización anatómica de administración", "definition": "Representation defined by the system. A representation of the meaning of the code in the system, following the rules of the system." }, { "id": "Immunization.route", "path": "Immunization.route", "short": "Vía de administración", "definition": "How vaccine entered body. The path by which the vaccine product is taken into the body.", "binding": { "strength": "extensible", "description": "Value set de Vias de administración vacunación", "valueSet": "https://unicas-fhir.sanidad.gob.es/ValueSet/ViasAdministracionVacunacion" } }, { "id": "Immunization.route.coding.system", "path": "Immunization.route.coding.system", "short": "OID del catálogo Sistema de Información en Vacunaciones e Inmunizaciones (SIVIAN)", "definition": "Posible OID de catálogo utilizado para indicar la vía de administración y su descripción correspondiente:\r\n\r\n- Catálogo de Sistema de Información en Vacunaciones e Inmunizaciones (SIVAIN): urn:oid:2.16.724.4.21.5.13" }, { "id": "Immunization.route.coding.code", "path": "Immunization.route.coding.code", "short": "Código de la vía de administración" }, { "id": "Immunization.route.coding.display", "path": "Immunization.route.coding.display", "short": "Descripción de la vía de administración", "definition": "Representation defined by the system. A representation of the meaning of the code in the system, following the rules of the system." }, { "id": "Immunization.doseQuantity", "path": "Immunization.doseQuantity", "short": "Dosis administrada", "definition": "Amount of vaccine administered. The quantity of vaccine product that was administered.", "min": 1 }, { "id": "Immunization.doseQuantity.value", "path": "Immunization.doseQuantity.value", "short": "Número de dosis", "definition": "Numerical value (with implicit precision). The value of the measured amount. The value includes an implicit precision in the presentation of the value." }, { "id": "Immunization.doseQuantity.unit", "path": "Immunization.doseQuantity.unit", "short": "Unidad de dosis", "definition": "Unit representation. A human-readable form of the unit." }, { "id": "Immunization.doseQuantity.system", "path": "Immunization.doseQuantity.system", "short": "URL del catálogo UCUM", "definition": "- Unified Code for Units of Measure (UCUM): http://unitsofmeasure.org" }, { "id": "Immunization.doseQuantity.code", "path": "Immunization.doseQuantity.code", "short": "Código de la unidad de la dosis", "definition": "Coded form of the unit. A computer processable form of the unit in some unit representation system." }, { "id": "Immunization.performer", "path": "Immunization.performer", "short": "Profesional sanitario", "definition": "Who performed event. Indicates who performed the immunization event.", "min": 1 }, { "id": "Immunization.performer.actor", "path": "Immunization.performer.actor", "short": "Referencia al profesional sanitario", "definition": "Individual or organization who was performing. The practitioner or organization who performed the action.", "type": [ { "code": "Reference", "targetProfile": [ "https://unicas-fhir.sanidad.gob.es/StructureDefinition/UNICASPractitionerRole", "https://unicas-fhir.sanidad.gob.es/StructureDefinition/UNICASPractitioner", "https://unicas-fhir.sanidad.gob.es/StructureDefinition/UNICASOrganization" ] } ] }, { "id": "Immunization.performer.actor.reference", "path": "Immunization.performer.actor.reference", "short": "Referencia recurso FHIR. Identificador de la referencia del recurso FHIR asociado cuando exista/creamos un recurso en el mismo servidor FHIR", "definition": "Formato: [base]/Practitioner?identifier=[OID registro de DNI]|[Número DNI]" }, { "id": "Immunization.performer.actor.type", "path": "Immunization.performer.actor.type", "short": "Tipo de recurso FHIR", "definition": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources. The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).", "min": 1 }, { "id": "Immunization.performer.actor.identifier", "path": "Immunization.performer.actor.identifier", "short": "Identificadores del profesional sanitario. Cuando no tengamos recurso Practitioner, se debera informar el identificador del profesional sanitario mediante DNI como dato mínimo. Adicionalmente, se puede informar el número colegiado del profesional sanitario como dato recomendado", "definition": "Logical reference, when literal reference is not known. An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "min": 1 }, { "id": "Immunization.performer.actor.identifier.extension:numeroColegiadoProfesionalSanitario", "path": "Immunization.performer.actor.identifier.extension", "sliceName": "numeroColegiadoProfesionalSanitario", "type": [ { "code": "Extension", "profile": [ "https://unicas-fhir.sanidad.gob.es/StructureDefinition/NumeroColegiadoProfesionalSanitario" ] } ], "isModifier": false }, { "id": "Immunization.performer.actor.identifier.type", "path": "Immunization.performer.actor.identifier.type", "short": "Tipos de documentos de identificación para persona ÚNICAS", "definition": "Description of identifier. A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "binding": { "strength": "extensible", "description": "Value set de Tipos de documentos de identificación para persona ÚNICAS", "valueSet": "https://unicas-fhir.sanidad.gob.es/ValueSet/TiposDocumentosIdentificacionPersona" } }, { "id": "Immunization.performer.actor.identifier.type.coding.system", "path": "Immunization.performer.actor.identifier.type.coding.system", "short": "URL del refset Tipos de documento para identificación personal de SNOMED CT. Extensión para España del SNS", "definition": "Posible URL de terminología utilizada para indicar el tipo de documentos de identificación y su descripción correspondiente:\r\n\r\n- Refset Tipos de documento para identificación personal del SNOMED CT. Extensión para España del SNS: http://snomed.info/sct/900000001000122104?fhir_vs-refset/900000251000122107" }, { "id": "Immunization.performer.actor.identifier.type.coding.code", "path": "Immunization.performer.actor.identifier.type.coding.code", "short": "Código del identificador" }, { "id": "Immunization.performer.actor.identifier.type.coding.display", "path": "Immunization.performer.actor.identifier.type.coding.display", "short": "Decripción del identificador", "definition": "Representation defined by the system. A representation of the meaning of the code in the system, following the rules of the system." }, { "id": "Immunization.performer.actor.identifier.system", "path": "Immunization.performer.actor.identifier.system", "short": "OID registro de DNI", "definition": "The namespace for the identifier value. Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique." }, { "id": "Immunization.performer.actor.identifier.value", "path": "Immunization.performer.actor.identifier.value", "short": "Número del DNI", "definition": "The value that is unique. The portion of the identifier typically relevant to the user and which is unique within the context of the system." }, { "id": "Immunization.performer.actor.display", "path": "Immunization.performer.actor.display", "short": "Nombre completo del profesional sanitario", "definition": "Text alternative for the resource. Plain text narrative that identifies the resource in addition to the resource reference." }, { "id": "Immunization.reason", "path": "Immunization.reason", "short": "Motivo de la vacunación", "definition": "Why immunization occurred. Describes why the immunization occurred in coded or textual form, or Indicates another resource (Condition, Observation or DiagnosticReport) whose existence justifies this immunization.", "min": 1, "binding": { "strength": "extensible", "description": "Value set de Motivos de vacunación", "valueSet": "https://unicas-fhir.sanidad.gob.es/ValueSet/MotivosVacunacion" } }, { "id": "Immunization.reason.concept", "path": "Immunization.reason.concept", "short": "Motivo de la vacunación", "definition": "Reference to a concept (by class). A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology." }, { "id": "Immunization.reason.concept.coding.system", "path": "Immunization.reason.concept.coding.system", "short": "OID del catálogo Sistema de Información en Vacunaciones e Inmunizaciones (SIVIAN)", "definition": "Posible OID de catálogo utilizado para indicar el motivo de la vacunación y su descripción correspondiente:\r\n\r\n- Catálogo de Sistema de Información en Vacunaciones e Inmunizaciones (SIVAIN): urn:oid:2.16.724.4.21.5.13", "min": 1 }, { "id": "Immunization.reason.concept.coding.code", "path": "Immunization.reason.concept.coding.code", "short": "Código del motivo de la vacunación", "min": 1 }, { "id": "Immunization.reason.concept.coding.display", "path": "Immunization.reason.concept.coding.display", "short": "Descripción del motivo de la vacunación", "definition": "Representation defined by the system. A representation of the meaning of the code in the system, following the rules of the system.", "min": 1 } ] } }