{
"description": "Extension definition for Mapping between ```API``` and ```Profile```. CapabilityStatement.rest.resource.profile has two different profile statements:\\n\\n* profile - the overall system profile for a resource\\n* supportedProfile 0..* - a particular profile that the system supports\\n\\nWhat is missing from this picture is defining which resources conform to\\nwhich profile. Sometimes, of course, it's impossible to define this, but\\nquite often, there's an algorithmic relationship that a server or client\\ncould use to know that resources with a particular set of values will or should\\nconform to a given profile.\\n\\nThis extension defines a relationship between a search string and a profile.\\nAny resource that meets a given search string will be expected to conform to the particular profile. If more than one profile is nominated for a search string, resources SHALL conform to all the listed profiles. The last extension can be without a search matches and remaining resources\\n\\nThis extension repeats, and order is important - once a match is found, this profile is the one that applies. Todo: If this extension is useful, it will be moved to the core extensions pack",
"_filename": "StructureDefinition-profile-mapping.json",
"package_name": "hl7.fhir.uv.tools.r3",
"date": "2025-04-17T05:34:58+10:00",
"derivation": "constraint",
"publisher": "HL7 International / FHIR Infrastructure",
"fhirVersion": "3.0.2",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
} ]
} ],
"name": "ProfileMapping",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Extension",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "Profile Mapping Extension",
"package_version": "0.5.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueCode": "2"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status-reason",
"valueCode": "Extensions that have been modified for R3 are still draft while real-world experience is collected"
} ],
"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": "Extension definition for Mapping between API and Profile. CapabilityStatement.rest.reosurce.profile has two different profile statements:\n\n* profile - the overall system profile for a resource\n* supportedProfile 0..* - a particular profile that the system supports\n\nWhat is missing from this picture is defining which resources conform to\nwhich profile. Sometimes, of course, it's impossible to define this, but\nquite often, there's an algorithmic relationship that a server or client\ncould use to know that resources with a particular set of values will or should\nconform to a given profile.\n\nThis extension defines a relationship between a search string and a profile.\nAny resource that meets a given search string will be expected to conform to the\nparticular profile.\n\n\nThis extension repeats, and order is important - once a match is found, this profile is the one that applies.",
"short": "profile-mapping",
"max": "*",
"id": "Extension",
"condition": [ "ele-1" ],
"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": 2,
"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.extension",
"min": 1,
"definition": "An Extension",
"short": "The search string for this mapping",
"type": [ {
"code": "Extension"
} ],
"sliceName": "search",
"max": "1",
"id": "Extension.extension:search",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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.extension:search.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "0",
"id": "Extension.extension:search.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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": "search",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:search.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.extension.value[x]",
"min": 0,
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Extension.extension:search.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"min": 1,
"definition": "An Extension",
"short": "The profile that must match this search string",
"type": [ {
"code": "Extension"
} ],
"sliceName": "profile",
"max": "*",
"id": "Extension.extension:profile",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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.extension:profile.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "0",
"id": "Extension.extension:profile.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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": "profile",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:profile.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.extension.value[x]",
"min": 1,
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Extension.extension:profile.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"min": 0,
"definition": "An Extension",
"short": "Documentation about this particular profile-mapping",
"type": [ {
"code": "Extension"
} ],
"sliceName": "documentation",
"max": "1",
"id": "Extension.extension:documentation",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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.extension:documentation.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "0",
"id": "Extension.extension:documentation.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.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": "documentation",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:documentation.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.extension.value[x]",
"min": 1,
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "Extension.extension:documentation.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"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/tools/StructureDefinition/profile-mapping",
"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": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "markdown"
}, {
"code": "oid"
}, {
"code": "positiveInt"
}, {
"code": "string"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "Address"
}, {
"code": "Age"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "ContactPoint"
}, {
"code": "Count"
}, {
"code": "Distance"
}, {
"code": "Duration"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Money"
}, {
"code": "Period"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "Reference"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "1",
"id": "Extension.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
} ]
},
"status": "active",
"id": "a5c42322-8f51-49c9-a2a3-d52f621e9178",
"kind": "complex-type",
"url": "http://hl7.org/fhir/tools/StructureDefinition/profile-mapping",
"identifier": [ {
"value": "urn:oid:2.16.840.1.113883.4.642.40.1.42.37",
"system": "urn:ietf:rfc:3986"
} ],
"context": [ "CapabilityStatement.rest.resource" ],
"version": "0.5.0",
"differential": {
"element": [ {
"id": "Extension",
"max": "*",
"min": 0,
"path": "Extension",
"short": "profile-mapping",
"definition": "Extension definition for Mapping between API and Profile. CapabilityStatement.rest.reosurce.profile has two different profile statements:\n\n* profile - the overall system profile for a resource\n* supportedProfile 0..* - a particular profile that the system supports\n\nWhat is missing from this picture is defining which resources conform to\nwhich profile. Sometimes, of course, it's impossible to define this, but\nquite often, there's an algorithmic relationship that a server or client\ncould use to know that resources with a particular set of values will or should\nconform to a given profile.\n\nThis extension defines a relationship between a search string and a profile.\nAny resource that meets a given search string will be expected to conform to the\nparticular profile.\n\n\nThis extension repeats, and order is important - once a match is found, this profile is the one that applies."
}, {
"id": "Extension.extension:search",
"max": "1",
"min": 1,
"path": "Extension.extension",
"type": [ {
"code": "Extension"
} ],
"short": "The search string for this mapping",
"sliceName": "search"
}, {
"id": "Extension.extension:search.extension",
"max": "0",
"path": "Extension.extension.extension"
}, {
"id": "Extension.extension:search.url",
"path": "Extension.extension.url",
"type": [ {
"code": "uri"
} ],
"fixedUri": "search"
}, {
"id": "Extension.extension:search.value[x]",
"min": 0,
"path": "Extension.extension.value[x]",
"type": [ {
"code": "string"
} ]
}, {
"id": "Extension.extension:profile",
"max": "*",
"min": 1,
"path": "Extension.extension",
"type": [ {
"code": "Extension"
} ],
"short": "The profile that must match this search string",
"sliceName": "profile"
}, {
"id": "Extension.extension:profile.extension",
"max": "0",
"path": "Extension.extension.extension"
}, {
"id": "Extension.extension:profile.url",
"path": "Extension.extension.url",
"type": [ {
"code": "uri"
} ],
"fixedUri": "profile"
}, {
"id": "Extension.extension:profile.value[x]",
"min": 1,
"path": "Extension.extension.value[x]",
"type": [ {
"code": "uri"
} ]
}, {
"id": "Extension.extension:documentation",
"max": "1",
"min": 0,
"path": "Extension.extension",
"type": [ {
"code": "Extension"
} ],
"short": "Documentation about this particular profile-mapping",
"sliceName": "documentation"
}, {
"id": "Extension.extension:documentation.extension",
"max": "0",
"path": "Extension.extension.extension"
}, {
"id": "Extension.extension:documentation.url",
"path": "Extension.extension.url",
"type": [ {
"code": "uri"
} ],
"fixedUri": "documentation"
}, {
"id": "Extension.extension:documentation.value[x]",
"min": 1,
"path": "Extension.extension.value[x]",
"type": [ {
"code": "markdown"
} ]
}, {
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/tools/StructureDefinition/profile-mapping"
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"contextType": "resource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension"
}