{
"description": "R5: `Appointment.participant.required` additional types (boolean) additional types from child elements (value)",
"_filename": "StructureDefinition-ext-R5-Appointment.par.required.json",
"package_name": "hl7.fhir.uv.xver-r5.r3",
"date": "2026-03-17T21:02:03.8104715+00:00",
"derivation": "constraint",
"publisher": "FHIR Infrastructure",
"fhirVersion": "3.0.2",
"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.participant.required` as defined in FHIR R5\r\nin FHIR STU3.\r\n\r\nThe source element is defined as:\r\n`Appointment.participant.required` 0..1 `boolean`\r\n\r\nAcross FHIR versions, the element set has been mapped as:\r\n* R5: `Appointment.participant.required` 0..1 `boolean`\n* R4B: `Appointment.participant.required` 0..1 `code`\n* R4: `Appointment.participant.required` 0..1 `code`\n* STU3: `Appointment.participant.required` 0..1 `code`\r\n\r\nFollowing are the generation technical comments:\r\nElement `Appointment.participant.required` is mapped to FHIR STU3 element `Appointment.participant.required` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.participant.required` do not cover the following types: boolean.\nThe mappings for `Appointment.participant.required` do not cover the following types based on type expansion: value.",
"name": "ExtensionAppointment_Participant_Required",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Extension",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "R5: The participant is required to attend (optional when false) 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.r3"
}, {
"url": "version",
"valueString": "0.1.0"
}, {
"url": "uri",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r3"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r3"
} ]
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r3"
} ]
}
} ],
"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",
"severity": "error",
"expression": "hasValue() | (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",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension",
"min": 0,
"definition": "R5: `Appointment.participant.required` additional types (boolean) additional types from child elements (value)",
"isModifier": false,
"short": "R5: The participant is required to attend (optional when false) additional types",
"max": "1",
"id": "Extension",
"condition": [ "ele-1" ],
"comment": "Element `Appointment.participant.required` is mapped to FHIR STU3 element `Appointment.participant.required` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.participant.required` do not cover the following types: boolean.\nThe mappings for `Appointment.participant.required` do not cover the following types based on type expansion: value.\nFor the use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present include the patient in the subject field, but do not include them as a participant - this was formerly done prior to R5 with required='information-only'.",
"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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
}, {
"path": "Extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.participant.required",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "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"
}
}, {
"path": "Extension.value[x]",
"min": 0,
"definition": "Whether this participant is required to be present at the meeting. If false, the participant is optional.",
"short": "The participant is required to attend (optional when false)",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Extension.value[x]",
"comment": "For the use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present include the patient in the subject field, but do not include them as a participant - this was formerly done prior to R5 with required='information-only'.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
} ]
},
"status": "active",
"id": "3ff692c3-376a-475c-a2d6-267f8d8c6567",
"kind": "complex-type",
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.participant.required",
"context": [ "Appointment.participant.required" ],
"version": "0.1.0",
"differential": {
"element": [ {
"path": "Extension",
"min": 0,
"definition": "R5: `Appointment.participant.required` additional types (boolean) additional types from child elements (value)",
"isModifier": false,
"short": "R5: The participant is required to attend (optional when false) additional types",
"max": "1",
"id": "Extension",
"comment": "Element `Appointment.participant.required` is mapped to FHIR STU3 element `Appointment.participant.required` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.participant.required` do not cover the following types: boolean.\nThe mappings for `Appointment.participant.required` do not cover the following types based on type expansion: value.\nFor the use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present include the patient in the subject field, but do not include them as a participant - this was formerly done prior to R5 with required='information-only'.",
"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.participant.required"
}, {
"path": "Extension.value[x]",
"min": 0,
"definition": "Whether this participant is required to be present at the meeting. If false, the participant is optional.",
"short": "The participant is required to attend (optional when false)",
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Extension.value[x]",
"comment": "For the use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present include the patient in the subject field, but do not include them as a participant - this was formerly done prior to R5 with required='information-only'.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
} ]
},
"contact": [ {
"name": "FHIR Infrastructure",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"contextType": "resource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension"
}