{ "description": "This profile represents the constraint applied to the CodeableConcept data type by the PS-CA project to use the [PS-CA Coding](http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/Coding-ca-ps) data type profile in a way that is informed by the constraints of the [CodeableConcept IPS-UV profile](http://hl7.org/fhir/uv/ips/StructureDefinition-CodeableConcept-uv-ips.html) but removes the overarching expectation that all patient summary creators must demonstrate they can support codings for conformance.", "_filename": "StructureDefinition-CodeableConcept-ca-ps.json", "package_name": "ca.infoway.io.psca", "date": "2022-01-17T01:23:00-08:00", "derivation": "constraint", "publisher": "Canada Health Infoway", "fhirVersion": "4.0.1", "jurisdiction": [ { "coding": [ { "code": "CA", "system": "urn:iso:std:iso:3166" } ] } ], "name": "CodeableConceptPSCA", "mapping": [ { "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping", "identity": "v2" }, { "uri": "http://hl7.org/v3", "name": "RIM Mapping", "identity": "rim" }, { "uri": "http://hl7.org/orim", "name": "Ontological RIM Mapping", "identity": "orim" } ], "abstract": false, "copyright": "Copyright © 2021,2022 Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).", "type": "CodeableConcept", "experimental": "false", "resourceType": "StructureDefinition", "title": "Codeable Concept (PS-CA)", "package_version": "0.0.4", "snapshot": { "element": [ { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "CodeableConcept", "min": 0, "definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.", "isModifier": false, "short": "Concept - reference to a terminology or just text", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "CE/CNE/CWE", "identity": "v2" }, { "map": "CD", "identity": "rim" }, { "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD", "identity": "orim" } ], "max": "*", "id": "CodeableConcept", "condition": [ "ele-1" ], "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.", "base": { "max": "*", "min": 0, "path": "CodeableConcept" } }, { "path": "CodeableConcept.id", "min": 0, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "isModifier": false, "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "CodeableConcept.id", "base": { "max": "1", "min": 0, "path": "Element.id" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "CodeableConcept.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "CodeableConcept.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "CodeableConcept.coding", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "definition": "A reference to a code defined by a terminology system.", "isModifier": false, "short": "A reference to a code defined by a terminology system", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6", "identity": "v2" }, { "map": "CV", "identity": "rim" }, { "map": "fhir:Coding rdfs:subClassOf dt:CDCoding", "identity": "orim" } ], "type": [ { "code": "Coding", "profile": [ "http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/Coding-ca-ps" ] } ], "max": "*", "id": "CodeableConcept.coding", "condition": [ "ele-1" ], "comment": "While the IPS-UV specification considers this a Must Support element, some systems will not have the ability to support codings for every codeableConcept, further feedback is required on whether these systems are still expected to be able to demonstrate they can construct this element when developing the patient summary instance.\r\n\r\nImplementors that support codings should still send the codings for codeable concepts if they are available and receivers should not produce failures or rejections if codings are included in the patient summary in the first release (a base tenet of FHIR).\r\n\r\nAdditionally vendors should expect that some jurisdictions may further constrain support of this element within the context of their own jurisdictional content", "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "CodeableConcept.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "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.", "isModifier": false, "short": "Plain text representation of the concept", "mapping": [ { "map": "C*E.9. But note many systems use C*E.2 for this", "identity": "v2" }, { "map": "./originalText[mediaType/code=\"text/plain\"]/data", "identity": "rim" }, { "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText", "identity": "orim" } ], "type": [ { "code": "string" } ], "mustSupport": true, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "id": "CodeableConcept.text", "comment": "Very often the text is the same as a displayName of one of the codings.", "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "isSummary": true } ] }, "status": "draft", "id": "59bb8f02-a758-4acd-9140-d32d8ab79598", "kind": "complex-type", "url": "http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps", "version": "0.0.4", "differential": { "element": [ { "id": "CodeableConcept", "path": "CodeableConcept" }, { "id": "CodeableConcept.coding", "path": "CodeableConcept.coding", "type": [ { "code": "Coding", "profile": [ "http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/Coding-ca-ps" ] } ], "comment": "While the IPS-UV specification considers this a Must Support element, some systems will not have the ability to support codings for every codeableConcept, further feedback is required on whether these systems are still expected to be able to demonstrate they can construct this element when developing the patient summary instance.\r\n\r\nImplementors that support codings should still send the codings for codeable concepts if they are available and receivers should not produce failures or rejections if codings are included in the patient summary in the first release (a base tenet of FHIR).\r\n\r\nAdditionally vendors should expect that some jurisdictions may further constrain support of this element within the context of their own jurisdictional content" }, { "id": "CodeableConcept.text", "path": "CodeableConcept.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "mustSupport": true } ] }, "contact": [ { "name": "National Standards Release Centre", "telecom": [ { "value": "http://www.infoway-inforoute.ca", "system": "url" }, { "value": "standards@infoway-inforoute.ca", "system": "email" } ] } ], "baseDefinition": "http://hl7.org/fhir/StructureDefinition/CodeableConcept" }