FHIR IG analytics| Package | hl7.fhir.uv.xver-r5.r4b |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-ext-R5-Appointment.reason.json |
| FHIR Version | R4B |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition ext-R5-Appointment.reason
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..* | Extension(4.3.0) | R5: Reason this appointment is scheduled additional types | |
 url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.reason" | |
  value[x] | 0..1 | CodeableReference(Cross-version Profile for R5.Condition for use in FHIR R4B(0.1.0) | Condition | Cross-version Profile for R5.Procedure for use in FHIR R4B(0.1.0) | Procedure | Cross-version Profile for R5.Observation for use in FHIR R4B(0.1.0) | Observation | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4B(0.1.0) | ImmunizationRecommendation) | Reason this appointment is scheduled | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "ext-R5-Appointment.reason",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"extension": [
{
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r5.r4b"
},
{
"url": "version",
"valueString": "0.1.0"
},
{
"url": "uri",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r4b"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"extension": [
{
"url": "startFhirVersion",
"valueCode": "4.3"
},
{
"url": "endFhirVersion",
"valueCode": "4.3"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r4b"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r4b"
}
]
}
}
],
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.reason",
"version": "0.1.0",
"name": "ExtensionAppointment_Reason",
"title": "R5: Reason this appointment is scheduled additional types",
"status": "active",
"experimental": false,
"date": "2026-03-17T21:02:03.8104715+00:00",
"publisher": "FHIR Infrastructure",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "R5: `Appointment.reason` additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/Condition), CodeableReference(http://hl7.org/fhir/StructureDefinition/Procedure), CodeableReference(http://hl7.org/fhir/StructureDefinition/Observation), CodeableReference(http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation))",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"purpose": "This extension is part of the cross-version definitions generated to enable use of the\r\nelement `Appointment.reason` as defined in FHIR R5\r\nin FHIR R4B.\r\n\r\nThe source element is defined as:\r\n`Appointment.reason` 0..* `CodeableReference(http://hl7.org/fhir/StructureDefinition/Condition,http://hl7.org/fhir/StructureDefinition/Procedure,http://hl7.org/fhir/StructureDefinition/Observation,http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation)`\r\n\r\nFollowing are the generation technical comments:\r\nElement `Appointment.reason` is mapped to FHIR R4B element `Appointment.reasonCode` as `SourceIsBroaderThanTarget`.\nElement `Appointment.reason` is mapped to FHIR R4B element `Appointment.reasonReference` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.reason` do not cover the following types: CodeableReference.",
"fhirVersion": "4.3.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Appointment"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension|4.3.0",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.3.0"
}
],
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "R5: Reason this appointment is scheduled additional types",
"definition": "R5: `Appointment.reason` additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/Condition), CodeableReference(http://hl7.org/fhir/StructureDefinition/Procedure), CodeableReference(http://hl7.org/fhir/StructureDefinition/Observation), CodeableReference(http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation))",
"comment": "Element `Appointment.reason` is mapped to FHIR R4B element `Appointment.reasonCode` as `SourceIsBroaderThanTarget`.\nElement `Appointment.reason` is mapped to FHIR R4B element `Appointment.reasonReference` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.reason` do not cover the following types: CodeableReference.",
"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 unless an empty Parameters resource",
"expression": "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath": "@value|f:*|h:div|self::f:Parameters",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.3.0"
},
{
"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": "http://hl7.org/fhir/StructureDefinition/Extension|4.3.0"
}
],
"isModifier": false
},
{
"id": "Extension.id",
"path": "Extension.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": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension",
"path": "Extension.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though 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())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.3.0"
},
{
"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": "http://hl7.org/fhir/StructureDefinition/Extension|4.3.0"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.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.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.reason",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Reason this appointment is scheduled",
"definition": "The reason that this appointment is being scheduled. This is more clinical than administrative. This can be coded, or as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableReference",
"targetProfile": [
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Condition|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Condition|4.3.0",
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Procedure|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Procedure|4.3.0",
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Observation|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Observation|4.3.0",
"http://hl7.org/fhir/5.0/StructureDefinition/profile-ImmunizationRecommendation|0.1.0",
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation|4.3.0"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.3.0"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "R5: Reason this appointment is scheduled additional types",
"definition": "R5: `Appointment.reason` additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/Condition), CodeableReference(http://hl7.org/fhir/StructureDefinition/Procedure), CodeableReference(http://hl7.org/fhir/StructureDefinition/Observation), CodeableReference(http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation))",
"comment": "Element `Appointment.reason` is mapped to FHIR R4B element `Appointment.reasonCode` as `SourceIsBroaderThanTarget`.\nElement `Appointment.reason` is mapped to FHIR R4B element `Appointment.reasonReference` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.reason` do not cover the following types: CodeableReference.",
"min": 0,
"max": "*",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "Extension.url",
"path": "Extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.reason"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Reason this appointment is scheduled",
"definition": "The reason that this appointment is being scheduled. This is more clinical than administrative. This can be coded, or as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableReference",
"targetProfile": [
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Condition|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Condition|4.3.0",
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Procedure|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Procedure|4.3.0",
"http://hl7.org/fhir/5.0/StructureDefinition/profile-Observation|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Observation|4.3.0",
"http://hl7.org/fhir/5.0/StructureDefinition/profile-ImmunizationRecommendation|0.1.0",
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation|4.3.0"
]
}
]
}
]
}
}