FHIR IG analytics
| Package | hl7.fhir.uv.xver-r4.r5 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-ext-R4-Appointment.reasonReference.json |
| FHIR Version | R5 |
| Source | http://hl7.org/fhir/uv/xver-r4.r5/0.1.0/StructureDefinition-ext-R4-Appointment.reasonReference.html |
| URL | http://hl7.org/fhir/4.0/StructureDefinition/extension-Appointment.reasonReference |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-03-17T21:02:03.8104715+00:00 |
| Name | ExtensionAppointment_ReasonReference |
| Title | R4: Reason the appointment is to take place (resource) (new) |
| Realm | uv |
| Authority | hl7 |
| Description | R4: `Appointment.reasonReference` (new:Reference(Condition,Procedure,Observation,ImmunizationRecommendation)) |
| Purpose | This extension is part of the cross-version definitions generated to enable use of the
element `Appointment.reasonReference` as defined in FHIR R4
in FHIR R5.
The source element is defined as:
`Appointment.reasonReference` 0..* `Reference(http://hl7.org/fhir/StructureDefinition/Condition,http://hl7.org/fhir/StructureDefinition/Procedure,http://hl7.org/fhir/StructureDefinition/Observation,http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation)`
Across FHIR versions, the element set has been mapped as:
* R4: `Appointment.reasonReference` 0..* `Reference(http://hl7.org/fhir/StructureDefinition/Condition,http://hl7.org/fhir/StructureDefinition/Procedure,http://hl7.org/fhir/StructureDefinition/Observation,http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation)`
* R4B: `Appointment.reasonReference` 0..* `Reference(http://hl7.org/fhir/StructureDefinition/Condition,http://hl7.org/fhir/StructureDefinition/Procedure,http://hl7.org/fhir/StructureDefinition/Observation,http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation)`
Following are the generation technical comments:
Element `Appointment.reasonReference` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.
Element `Appointment.reasonReference` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). |
| Type | Extension |
| Kind | complex-type |
Resources that use this resource
Resources that this resource uses
| StructureDefinition |
| hl7.fhir.uv.xver-r4.r4b#0.1.0 | profile-Condition | Cross-version Profile for R4.Condition for use in FHIR R4B |
| hl7.fhir.uv.xver-r4.r4b#0.1.0 | profile-ImmunizationRecommendation | Cross-version Profile for R4.ImmunizationRecommendation for use in FHIR R4B |
| hl7.fhir.uv.xver-r4.r4b#0.1.0 | profile-Observation | Cross-version Profile for R4.Observation for use in FHIR R4B |
| hl7.fhir.uv.xver-r4.r4b#0.1.0 | profile-Procedure | Cross-version Profile for R4.Procedure for use in FHIR R4B |
Examples of Use for Extension
No extension usage examples found
Narrative
Note: links and images are rebased to the (stated) source
Source1
{
"resourceType": "StructureDefinition",
"id": "ext-R4-Appointment.reasonReference",
"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-r4.r5"
},
{
"url": "version",
"valueString": "0.1.0"
},
{
"url": "uri",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4.r5"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"extension": [
{
"url": "startFhirVersion",
"valueCode": "5.0"
},
{
"url": "endFhirVersion",
"valueCode": "5.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
},
{
"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-r4.r5"
}
]
}
},
{
"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-r4.r5"
}
]
}
}
],
"url": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Appointment.reasonReference",
"version": "0.1.0",
"name": "ExtensionAppointment_ReasonReference",
"title": "R4: Reason the appointment is to take place (resource) (new)",
"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": "R4: `Appointment.reasonReference` (new:Reference(Condition,Procedure,Observation,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.reasonReference` as defined in FHIR R4\r\nin FHIR R5.\r\n\r\nThe source element is defined as:\r\n`Appointment.reasonReference` 0..* `Reference(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\nAcross FHIR versions, the element set has been mapped as:\r\n* R4: `Appointment.reasonReference` 0..* `Reference(http://hl7.org/fhir/StructureDefinition/Condition,http://hl7.org/fhir/StructureDefinition/Procedure,http://hl7.org/fhir/StructureDefinition/Observation,http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation)`\n* R4B: `Appointment.reasonReference` 0..* `Reference(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.reasonReference` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.reasonReference` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).",
"fhirVersion": "5.0.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|5.0.0",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
}
],
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "R4: Reason the appointment is to take place (resource) (new)",
"definition": "R4: `Appointment.reasonReference` (new:Reference(Condition,Procedure,Observation,ImmunizationRecommendation))",
"comment": "Element `Appointment.reasonReference` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.reasonReference` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"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|5.0.0"
},
{
"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|5.0.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"
}
],
"condition": [
"ele-1"
],
"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 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|5.0.0"
},
{
"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|5.0.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/4.0/StructureDefinition/extension-Appointment.reasonReference",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Reason the appointment is to take place (resource)",
"definition": "Reason the appointment has been scheduled to take place, 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": "Reference",
"targetProfile": [
"http://hl7.org/fhir/4.0/StructureDefinition/profile-Condition|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Condition|5.0.0",
"http://hl7.org/fhir/4.0/StructureDefinition/profile-Procedure|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Procedure|5.0.0",
"http://hl7.org/fhir/4.0/StructureDefinition/profile-Observation|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Observation|5.0.0",
"http://hl7.org/fhir/4.0/StructureDefinition/profile-ImmunizationRecommendation|0.1.0",
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation|5.0.0"
]
}
],
"condition": [
"ext-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|5.0.0"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "R4: Reason the appointment is to take place (resource) (new)",
"definition": "R4: `Appointment.reasonReference` (new:Reference(Condition,Procedure,Observation,ImmunizationRecommendation))",
"comment": "Element `Appointment.reasonReference` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.reasonReference` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).",
"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/4.0/StructureDefinition/extension-Appointment.reasonReference"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Reason the appointment is to take place (resource)",
"definition": "Reason the appointment has been scheduled to take place, 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": "Reference",
"targetProfile": [
"http://hl7.org/fhir/4.0/StructureDefinition/profile-Condition|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Condition|5.0.0",
"http://hl7.org/fhir/4.0/StructureDefinition/profile-Procedure|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Procedure|5.0.0",
"http://hl7.org/fhir/4.0/StructureDefinition/profile-Observation|0.1.0",
"http://hl7.org/fhir/StructureDefinition/Observation|5.0.0",
"http://hl7.org/fhir/4.0/StructureDefinition/profile-ImmunizationRecommendation|0.1.0",
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation|5.0.0"
]
}
]
}
]
}
}
Extension 
value[x] 
FHIR
FHIRsmith