STU3 Candidate
TerminologyThis page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R4B R4 R3
Alternative names
{
"resourceType": "StructureDefinition",
"id": "codesystem-otherName",
"url": "http://hl7.org/fhir/StructureDefinition/codesystem-otherName",
"name": "Alternative names",
"status": "draft",
"publisher": "HL7",
"date": "2016-12-06T12:22:34+11:00",
"description": "Human readable names for the codesystem.",
"fhirVersion": "1.8.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"contextType": "resource",
"context": [
"CodeSystem"
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Extension:alternativenames",
"path": "Extension",
"short": "Alternative names",
"definition": "Human readable names for the codesystem.",
"min": 0,
"max": "*",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "Extension"
}
],
"isModifier": false
},
{
"id": "Extension:alternativenames.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension:alternativenames.extension",
"path": "Extension.extension",
"slicing": {
"id": "89",
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension:alternativenames.extension:name",
"path": "Extension.extension",
"sliceName": "name",
"short": "Human readable, short and specific",
"definition": "This name is intended to be human readable, short and as specific as possible and to convey the purpose of the value set. It is considered to be the name of the value set.",
"comments": "This need not be unique. However some use cases require uniqueness within a namespace and therefore best practice would be to make the name unique.",
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false
},
{
"id": "Extension:alternativenames.extension:name.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension:alternativenames.extension:name.extension:extension",
"path": "Extension.extension.extension",
"sliceName": "extension",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension:alternativenames.extension:name.url",
"path": "Extension.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comments": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "name",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension:alternativenames.extension:name.valueString",
"path": "Extension.extension.valueString",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension:alternativenames.extension:preferred",
"path": "Extension.extension",
"sliceName": "preferred",
"short": "Which name is preferred for this language",
"definition": "Flag that this Name in this Name Language is the preferred human-readable signifier in this language.",
"comments": "There may be multiple human readable names in a given language, and this flag indicates which of them is preferred for the given language.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false
},
{
"id": "Extension:alternativenames.extension:preferred.id",
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension:alternativenames.extension:preferred.extension:extension",
"path": "Extension.extension.extension",
"sliceName": "extension",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension:alternativenames.extension:preferred.url",
"path": "Extension.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comments": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "preferred",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension:alternativenames.extension:preferred.valueBoolean",
"path": "Extension.extension.valueBoolean",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension:alternativenames.url",
"path": "Extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comments": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/codesystem-otherName",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension:alternativenames.value[x]",
"path": "Extension.value[x]",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 0,
"max": "0",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "Meta"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension:alternativenames",
"path": "Extension",
"short": "Alternative names",
"definition": "Human readable names for the codesystem.",
"min": 0,
"max": "*",
"isModifier": false
},
{
"id": "Extension:alternativenames.extension:name",
"path": "Extension.extension",
"sliceName": "name",
"short": "Human readable, short and specific",
"definition": "This name is intended to be human readable, short and as specific as possible and to convey the purpose of the value set. It is considered to be the name of the value set.",
"comments": "This need not be unique. However some use cases require uniqueness within a namespace and therefore best practice would be to make the name unique.",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
},
{
"id": "Extension:alternativenames.extension:name.extension:extension",
"path": "Extension.extension.extension",
"sliceName": "extension",
"max": "0"
},
{
"id": "Extension:alternativenames.extension:name.url",
"path": "Extension.extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "name"
},
{
"id": "Extension:alternativenames.extension:name.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension:alternativenames.extension:preferred",
"path": "Extension.extension",
"sliceName": "preferred",
"short": "Which name is preferred for this language",
"definition": "Flag that this Name in this Name Language is the preferred human-readable signifier in this language.",
"comments": "There may be multiple human readable names in a given language, and this flag indicates which of them is preferred for the given language.",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
},
{
"id": "Extension:alternativenames.extension:preferred.extension:extension",
"path": "Extension.extension.extension",
"sliceName": "extension",
"max": "0"
},
{
"id": "Extension:alternativenames.extension:preferred.url",
"path": "Extension.extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "preferred"
},
{
"id": "Extension:alternativenames.extension:preferred.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "boolean"
}
]
},
{
"id": "Extension:alternativenames.url",
"path": "Extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/codesystem-otherName"
},
{
"id": "Extension:alternativenames.value[x]",
"path": "Extension.value[x]",
"min": 0,
"max": "0"
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Candidate (v1.8.0-10521) generated on Tue, Dec 6, 2016 12:25+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change