{
"description": "R5: `Appointment.note` additional types (Annotation) additional types from child elements (time)",
"_filename": "StructureDefinition-ext-R5-Appointment.note.json",
"package_name": "hl7.fhir.uv.xver-r5.r4",
"date": "2026-03-17T21:02:03.8104715+00:00",
"derivation": "constraint",
"publisher": "FHIR Infrastructure",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"purpose": "This extension is part of the cross-version definitions generated to enable use of the\r\nelement `Appointment.note` as defined in FHIR R5\r\nin FHIR R4.\r\n\r\nThe source element is defined as:\r\n`Appointment.note` 0..* `Annotation`\r\n\r\nAcross FHIR versions, the element set has been mapped as:\r\n* R5: `Appointment.note` 0..* `Annotation`\n* R4B: `Appointment.comment` 0..1 `string`\n* R4: `Appointment.comment` 0..1 `string`\r\n\r\nFollowing are the generation technical comments:\r\nElement `Appointment.note` is mapped to FHIR R4 element `Appointment.comment` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.note` do not cover the following types: Annotation.\nThe mappings for `Appointment.note` do not cover the following types based on type expansion: time.",
"name": "ExtensionAppointment_Note",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Extension",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "R5: note additional types",
"package_version": "0.1.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/package-source",
"extension": [ {
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r5.r4"
}, {
"url": "version",
"valueString": "0.1.0"
}, {
"url": "uri",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r4"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "4.0"
}, {
"url": "endFhirVersion",
"valueCode": "4.0"
} ]
}, {
"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.r4"
} ]
}
}, {
"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.r4"
} ]
}
} ],
"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|4.0.1",
"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|4.0.1",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension",
"min": 0,
"definition": "R5: `Appointment.note` additional types (Annotation) additional types from child elements (time)",
"isModifier": false,
"short": "R5: note additional types",
"max": "*",
"id": "Extension",
"condition": [ "ele-1" ],
"comment": "Element `Appointment.note` is mapped to FHIR R4 element `Appointment.comment` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.note` do not cover the following types: Annotation.\nThe mappings for `Appointment.note` do not cover the following types based on type expansion: time.\nAdditional text to aid in facilitating the appointment. For instance, a note might be, \"patient should proceed immediately to infusion room upon arrival\"\r\rWhere this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.\r\rTypically only the concept.text will be used, however occasionally a reference to some generic documentation (or specific) and also supports coded instructions if/when they are required.",
"base": {
"max": "*",
"min": 0,
"path": "Extension"
}
}, {
"path": "Extension.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": "Extension.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|4.0.1",
"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|4.0.1",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension.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": "Extension.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
}, {
"path": "Extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"isModifier": false,
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note",
"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": "uri"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"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|4.0.1",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Extension.value[x]",
"min": 0,
"definition": "Additional notes/comments about the appointment.",
"isModifier": false,
"short": "Additional comments",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "1",
"id": "Extension.value[x]",
"comment": "Additional text to aid in facilitating the appointment. For instance, a note might be, \"patient should proceed immediately to infusion room upon arrival\"\r\rWhere this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.\r\rTypically only the concept.text will be used, however occasionally a reference to some generic documentation (or specific) and also supports coded instructions if/when they are required.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
} ]
},
"status": "active",
"id": "f29e0674-18c2-4403-9fb4-e257906cef5b",
"kind": "complex-type",
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note",
"context": [ {
"type": "element",
"expression": "Appointment.comment"
} ],
"version": "0.1.0",
"differential": {
"element": [ {
"path": "Extension",
"min": 0,
"definition": "R5: `Appointment.note` additional types (Annotation) additional types from child elements (time)",
"isModifier": false,
"short": "R5: note additional types",
"max": "*",
"id": "Extension",
"comment": "Element `Appointment.note` is mapped to FHIR R4 element `Appointment.comment` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.note` do not cover the following types: Annotation.\nThe mappings for `Appointment.note` do not cover the following types based on type expansion: time.\nAdditional text to aid in facilitating the appointment. For instance, a note might be, \"patient should proceed immediately to infusion room upon arrival\"\r\rWhere this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.\r\rTypically only the concept.text will be used, however occasionally a reference to some generic documentation (or specific) and also supports coded instructions if/when they are required.",
"base": {
"max": "*",
"min": 0,
"path": "Extension"
}
}, {
"id": "Extension.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note"
}, {
"path": "Extension.value[x]",
"min": 0,
"definition": "Additional notes/comments about the appointment.",
"short": "Additional comments",
"type": [ {
"code": "Annotation"
} ],
"max": "1",
"id": "Extension.value[x]",
"comment": "Additional text to aid in facilitating the appointment. For instance, a note might be, \"patient should proceed immediately to infusion room upon arrival\"\r\rWhere this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.\r\rTypically only the concept.text will be used, however occasionally a reference to some generic documentation (or specific) and also supports coded instructions if/when they are required.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
} ]
},
"contact": [ {
"name": "FHIR Infrastructure",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
}