{
"description": "STU3: `ElementDefinition.pattern[x]` additional types (Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing, Meta)",
"_filename": "StructureDefinition-ext-R3-ElementDefinition.pattern.json",
"package_name": "hl7.fhir.uv.xver-r3.r5",
"date": "2026-03-17T21:02:03.8104715+00:00",
"derivation": "constraint",
"publisher": "FHIR Infrastructure",
"fhirVersion": "5.0.0",
"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 `ElementDefinition.pattern[x]` as defined in FHIR STU3\r\nin FHIR R5.\r\n\r\nThe source element is defined as:\r\n`ElementDefinition.pattern[x]` 0..1 `Address, Age, Annotation, Attachment, base64Binary, boolean, code, CodeableConcept, Coding, ContactPoint, Count, date, dateTime, decimal, Distance, Duration, HumanName, id, Identifier, instant, integer, markdown, Meta, Money, oid, Period, positiveInt, Quantity, Range, Ratio, Reference, SampledData, Signature, string, time, Timing, unsignedInt, uri`\r\n\r\nAcross FHIR versions, the element set has been mapped as:\r\n* STU3: `ElementDefinition.pattern[x]` 0..1 `Address, Age, Annotation, Attachment, base64Binary, boolean, code, CodeableConcept, Coding, ContactPoint, Count, date, dateTime, decimal, Distance, Duration, HumanName, id, Identifier, instant, integer, markdown, Meta, Money, oid, Period, positiveInt, Quantity, Range, Ratio, Reference, SampledData, Signature, string, time, Timing, unsignedInt, uri`\n* R4: `ElementDefinition.pattern[x]` 0..1 `Address, Age, Annotation, Attachment, base64Binary, boolean, canonical, code, CodeableConcept, Coding, ContactDetail, ContactPoint, Contributor, Count, DataRequirement, date, dateTime, decimal, Distance, Dosage, Duration, Expression, HumanName, id, Identifier, instant, integer, markdown, Meta, Money, oid, ParameterDefinition, Period, positiveInt, Quantity, Range, Ratio, Reference, RelatedArtifact, SampledData, Signature, string, time, Timing, TriggerDefinition, unsignedInt, uri, url, UsageContext, uuid`\n* R4B: `ElementDefinition.pattern[x]` 0..1 `Address, Age, Annotation, Attachment, base64Binary, boolean, canonical, code, CodeableConcept, CodeableReference, Coding, ContactDetail, ContactPoint, Contributor, Count, DataRequirement, date, dateTime, decimal, Distance, Dosage, Duration, Expression, HumanName, id, Identifier, instant, integer, markdown, Money, oid, ParameterDefinition, Period, positiveInt, Quantity, Range, Ratio, RatioRange, Reference, RelatedArtifact, SampledData, Signature, string, time, Timing, TriggerDefinition, unsignedInt, uri, url, UsageContext, uuid`\n* R5: `ElementDefinition.pattern[x]` 0..1 `Address, Age, Annotation, Attachment, Availability, base64Binary, boolean, canonical, code, CodeableConcept, CodeableReference, Coding, ContactDetail, ContactPoint, Count, DataRequirement, date, dateTime, decimal, Distance, Dosage, Duration, Expression, ExtendedContactDetail, HumanName, id, Identifier, instant, integer, integer64, markdown, Meta, Money, oid, ParameterDefinition, Period, positiveInt, Quantity, Range, Ratio, RatioRange, Reference, RelatedArtifact, SampledData, Signature, string, time, Timing, TriggerDefinition, unsignedInt, uri, url, UsageContext, uuid`\r\n\r\nFollowing are the generation technical comments:\r\nElement `ElementDefinition.pattern[x]` is mapped to FHIR R5 element `ElementDefinition.pattern[x]` as `RelatedTo`.\nThe mappings for `ElementDefinition.pattern[x]` do not cover the following types: Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Meta, Period, Range, Ratio, SampledData, Signature, Timing.\nThe target context `ElementDefinition.pattern[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ElementDefinition`.",
"name": "ExtensionElementDefinition_Pattern",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Extension",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "STU3: pattern 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-r3.r5"
}, {
"url": "version",
"valueString": "0.1.0"
}, {
"url": "uri",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r3.r5"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/version-specific-use",
"extension": [ {
"url": "startFhirVersion",
"valueCode": "5.0"
}, {
"url": "endFhirVersion",
"valueCode": "5.0"
} ]
}, {
"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-r3.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-r3.r5"
} ]
}
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|5.0.0",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension",
"min": 0,
"definition": "STU3: `ElementDefinition.pattern[x]` additional types (Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing, Meta)",
"isModifier": false,
"short": "STU3: pattern additional types",
"max": "1",
"id": "Extension",
"comment": "Element `ElementDefinition.pattern[x]` is mapped to FHIR R5 element `ElementDefinition.pattern[x]` as `RelatedTo`.\nThe mappings for `ElementDefinition.pattern[x]` do not cover the following types: Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Meta, Period, Range, Ratio, SampledData, Signature, Timing.\nThe target context `ElementDefinition.pattern[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ElementDefinition`.\nMostly used for fixing values of CodeableConcept. At present, pattern[x] is not recommended as a basis for slicing while issues related to this are investigated during the STU period.",
"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": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|5.0.0",
"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 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.",
"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/3.0/StructureDefinition/extension-ElementDefinition.pattern",
"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",
"source": "http://hl7.org/fhir/StructureDefinition/Element|5.0.0",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Extension.value[x]",
"min": 0,
"definition": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).",
"isModifier": false,
"short": "Value must have at least these property values",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Address"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "ContactPoint"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Period"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "1",
"id": "Extension.value[x]",
"condition": [ "ext-1" ],
"comment": "Mostly used for fixing values of CodeableConcept. At present, pattern[x] is not recommended as a basis for slicing while issues related to this are investigated during the STU period.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
} ]
},
"status": "active",
"id": "af556f06-a96b-429f-bdd7-a4052dcba993",
"kind": "complex-type",
"url": "http://hl7.org/fhir/3.0/StructureDefinition/extension-ElementDefinition.pattern",
"context": [ {
"type": "element",
"expression": "ElementDefinition"
} ],
"version": "0.1.0",
"differential": {
"element": [ {
"path": "Extension",
"min": 0,
"definition": "STU3: `ElementDefinition.pattern[x]` additional types (Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing, Meta)",
"isModifier": false,
"short": "STU3: pattern additional types",
"max": "1",
"id": "Extension",
"comment": "Element `ElementDefinition.pattern[x]` is mapped to FHIR R5 element `ElementDefinition.pattern[x]` as `RelatedTo`.\nThe mappings for `ElementDefinition.pattern[x]` do not cover the following types: Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Meta, Period, Range, Ratio, SampledData, Signature, Timing.\nThe target context `ElementDefinition.pattern[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ElementDefinition`.\nMostly used for fixing values of CodeableConcept. At present, pattern[x] is not recommended as a basis for slicing while issues related to this are investigated during the STU period.",
"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/3.0/StructureDefinition/extension-ElementDefinition.pattern"
}, {
"path": "Extension.value[x]",
"min": 0,
"definition": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).",
"short": "Value must have at least these property values",
"type": [ {
"code": "Address"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "ContactPoint"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Period"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "1",
"id": "Extension.value[x]",
"comment": "Mostly used for fixing values of CodeableConcept. At present, pattern[x] is not recommended as a basis for slicing while issues related to this are investigated during the STU period.",
"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|5.0.0"
}