FHIR Defined Concept Properties
draftA set of common concept properties for use on coded systems throughout the FHIR eco-system.
Properties
This code system defines the following properties for its concepts
| Code | URI | Type | Description |
| status | http://hl7.org/fhir/concept-properties#status | code | A code that indicates the status of the concept. Typical values are active, experimental, deprecated, and retired |
Concepts
This code system
http://hl7.org/fhir/concept-properties defines the following codes:
| Code | Display | Definition | Status |
| status | Status |
A code that indicates the status of the concept. Typical values are active, experimental, deprecated, and retired |
|
| inactive | Inactive |
True if the concept is not considered active - e.g. not a valid concept any more. Property type is boolean, default value is false. Note that the status property may also be used to indicate that a concept is inactive |
|
| effectiveDate | effectiveDate |
The date at which the concept status was last changed |
|
| deprecated | Deprecated |
The date at which a concept was deprecated. Concepts that are deprecated but not inactive can still be used, but their use is discouraged, and they should be expected to be made inactive in a future release. Property type is dateTime. Note that the status property may also be used to indicate that a concept is deprecated |
deprecated |
| deprecationDate | Deprecation Date |
The date at which a concept was deprecated. Concepts that are deprecated but not inactive can still be used, but their use is discouraged, and they should be expected to be made inactive in a future release. Property type is dateTime. Note that the status property may also be used to indicate that a concept is deprecated |
|
| retirementDate | Retirement Date |
The date at which a concept was retired |
|
| notSelectable | Not Selectable |
The concept is not intended to be chosen by the user - only intended to be used as a selector for other concepts. Note, though, that the interpretation of this is highly contextual; all concepts are selectable in some context. Property type is boolean |
|
| parent | Parent |
The concept identified in this property is a parent of the concept on which it is a property. The property type will be 'code'. The meaning of 'parent' is defined by the hierarchyMeaning attribute |
|
| child | Child |
The concept identified in this property is a child of the concept on which it is a property. The property type will be 'code'. The meaning of 'child' is defined by the hierarchyMeaning attribute |
|
| partOf | Part Of |
The concept identified in this property (by its code) contains this concept as a component (i.e. a part-of relationship rather than a subsumption relationship such as elbow is part-of arm |
|
| synonym | Synonym |
This property contains an alternative code that may be used to identify this concept instead of the primary code |
|
| comment | Comment |
A string that provides additional detail pertinent to the use or understanding of the concept |
|
| itemWeight | itemWeight |
A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores. In questionnaires, the item weight may be represented using the http://hl7.org/fhir/StructureDefinition/itemWeight extension |
{
"description" : "A set of common concept properties for use on coded systems throughout the FHIR eco-system.",
"meta" : {
"lastUpdated" : "2023-03-26T15:21:02.749+11:00"
},
"publisher" : "FHIR Project",
"jurisdiction" : [ {
"coding" : [ {
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
} ]
} ],
"content" : "complete",
"property" : [ {
"description" : "A code that indicates the status of the concept",
"type" : "code",
"code" : "status",
"uri" : "http://hl7.org/fhir/concept-properties#status"
} ],
"name" : "ConceptProperties",
"experimental" : true,
"resourceType" : "CodeSystem",
"title" : "FHIR Defined Concept Properties",
"extension" : [ {
"valueCode" : "vocab",
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"
}, {
"valueCode" : "normative",
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"
}, {
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 4
}, {
"valueBoolean" : true,
"url" : "http://hl7.org/fhir/StructureDefinition/codesystem-use-markdown"
}, {
"extension" : [ {
"valueString" : "concept",
"url" : "path"
}, {
"url" : "count",
"valueInteger" : 13
} ],
"url" : "http://health-samurai.io/extensions/excised-data"
}, {
"url" : "http://health-samurai.io/extensions/source",
"valueCode" : "db"
} ],
"status" : "draft",
"id" : "dd55fd66-100b-42ab-8e44-ded38d51bc16",
"valueSet" : "http://hl7.org/fhir/ValueSet/concept-properties",
"url" : "http://hl7.org/fhir/concept-properties",
"identifier" : [ {
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.4.1826"
} ],
"caseSensitive" : true,
"version" : "5.0.0",
"text" : {
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>\n <b>Properties</b>\n </p>\n <p>\n <b>This code system defines the following properties for its concepts</b>\n </p>\n <table class=\"grid\">\n <tr>\n <td>\n <b>Code</b>\n </td>\n <td>\n <b>URI</b>\n </td>\n <td>\n <b>Type</b>\n </td>\n <td>\n <b>Description</b>\n </td>\n </tr>\n <tr>\n <td>status</td>\n <td>http://hl7.org/fhir/concept-properties#status</td>\n <td>code</td>\n <td>A code that indicates the status of the concept. Typical values are active, experimental, deprecated, and retired</td>\n </tr>\n </table>\n <p>\n <b>Concepts</b>\n </p>\n <p>This code system \n <code>http://hl7.org/fhir/concept-properties</code> defines the following codes:\n </p>\n <table class=\"codes\">\n <tr>\n <td style=\"white-space:nowrap\">\n <b>Code</b>\n </td>\n <td>\n <b>Display</b>\n </td>\n <td>\n <b>Definition</b>\n </td>\n <td>\n <b>Status</b>\n </td>\n </tr>\n <tr>\n <td style=\"white-space:nowrap\">status\n <a name=\"concept-properties-status\"> </a>\n </td>\n <td>Status</td>\n <td>\n <div>\n <p>A code that indicates the status of the concept. Typical values are active, experimental, deprecated, and retired</p>\n\n </div>\n </td>\n <td/>\n </tr>\n <tr>\n <td style=\"white-space:nowrap\">inactive\n <a name=\"concept-properties-inactive\"> </a>\n </td>\n <td>Inactive</td>\n <td>\n <div>\n <p>True if the concept is not considered active - e.g. not a valid concept any more. Property type is boolean, default value is false. Note that the status property may also be used to indicate that a concept is inactive</p>\n\n </div>\n </td>\n <td/>\n </tr>\n <tr>\n <td style=\"white-space:nowrap\">effectiveDate\n <a name=\"concept-properties-effectiveDate\"> </a>\n </td>\n <td>effectiveDate</td>\n <td>\n <div>\n <p>The date at which the concept status was last changed</p>\n\n </div>\n </td>\n <td/>\n </tr>\n <tr style=\"background-color: #ffeeee\">\n <td style=\"white-space:nowrap\">deprecated\n <a name=\"concept-properties-deprecated\"> </a>\n </td>\n <td>Deprecated</td>\n <td>\n <div>\n <p>The date at which a concept was deprecated. Concepts that are deprecated but not inactive can still be used, but their use is discouraged, and they should be expected to be made inactive in a future release. Property type is dateTime. Note that the status property may also be used to indicate that a concept is deprecated</p>\n\n </div>\n </td>\n <td>deprecated</td>\n </tr>\n <tr>\n <td style=\"white-space:nowrap\">deprecationDate\n <a name=\"concept-properties-deprecationDate\"> </a>\n </td>\n <td>Deprecation Date</td>\n <td>\n <div>\n <p>The date at which a concept was deprecated. Concepts that are deprecated but not inactive can still be used, but their use is discouraged, and they should be expected to be made inactive in a future release. Property type is dateTime. Note that the status property may also be used to indicate that a concept is deprecated</p>\n\n </div>\n </td>\n <td/>\n </tr>\n <tr>\n <td style=\"white-space:nowrap\">retirementDate\n <a name=\"concept-properties-retirementDate\"> </a>\n </td>\n <td>Retirement Date</td>\n <td>\n <div>\n <p>The date at which a concept was retired</p>\n\n </div>\n </td>\n <td/>\n </tr>\n <tr>\n <td style=\"white-space:nowrap\">notSelectable\n <a name=\"concept-properties-notSelectable\"> </a>\n </td>\n <td>Not Selectable</td>\n <td>\n <div>\n <p>The concept is not intended to be chosen by the user - only intended to be used as a selector for other concepts. Note, though, that the interpretation of this is highly contextual; all concepts are selectable in some context. Property type is boolean</p>\n\n </div>\n </td>\n <td/>\n </tr>\n <tr>\n <td style=\"white-space:nowrap\">parent\n <a name=\"concept-properties-parent\"> </a>\n </td>\n <td>Parent</td>\n <td>\n <div>\n <p>The concept identified in this property is a parent of the concept on which it is a property. The property type will be 'code'. The meaning of 'parent' is defined by the hierarchyMeaning attribute</p>\n\n </div>\n </td>\n <td/>\n </tr>\n <tr>\n <td style=\"white-space:nowrap\">child\n <a name=\"concept-properties-child\"> </a>\n </td>\n <td>Child</td>\n <td>\n <div>\n <p>The concept identified in this property is a child of the concept on which it is a property. The property type will be 'code'. The meaning of 'child' is defined by the hierarchyMeaning attribute</p>\n\n </div>\n </td>\n <td/>\n </tr>\n <tr>\n <td style=\"white-space:nowrap\">partOf\n <a name=\"concept-properties-partOf\"> </a>\n </td>\n <td>Part Of</td>\n <td>\n <div>\n <p>The concept identified in this property (by its code) contains this concept as a component (i.e. a part-of relationship rather than a subsumption relationship such as elbow is part-of arm</p>\n\n </div>\n </td>\n <td/>\n </tr>\n <tr>\n <td style=\"white-space:nowrap\">synonym\n <a name=\"concept-properties-synonym\"> </a>\n </td>\n <td>Synonym</td>\n <td>\n <div>\n <p>This property contains an alternative code that may be used to identify this concept instead of the primary code</p>\n\n </div>\n </td>\n <td/>\n </tr>\n <tr>\n <td style=\"white-space:nowrap\">comment\n <a name=\"concept-properties-comment\"> </a>\n </td>\n <td>Comment</td>\n <td>\n <div>\n <p>A string that provides additional detail pertinent to the use or understanding of the concept</p>\n\n </div>\n </td>\n <td/>\n </tr>\n <tr>\n <td style=\"white-space:nowrap\">itemWeight\n <a name=\"concept-properties-itemWeight\"> </a>\n </td>\n <td>itemWeight</td>\n <td>\n <div>\n <p>A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores. In questionnaires, the item weight may be represented using the \n <a href=\"http://hl7.org/fhir/extensions/StructureDefinition-itemWeight.html\">http://hl7.org/fhir/StructureDefinition/itemWeight</a> extension\n </p>\n\n </div>\n </td>\n <td/>\n </tr>\n </table>\n </div>",
"status" : "generated"
}
}