FHIR IG analytics| Package | hl7.fhir.uv.xver-r4b.r3 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-profile-Binary.json |
| FHIR Version | R3 |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition profile-Binary
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Binary | 0..* | Binary | Pure binary content defined by a format other than FHIR | |
  meta | ||||
   Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:meta | 0..1 | Meta | R4B: meta additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Binary.meta | |
| securityContext | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:securityContext | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: Identifies another resource to use as proxy when enforcing access control additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "profile-Binary",
"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-r4b.r3"
},
{
"url": "version",
"valueString": "0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"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-r4b.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-r4b.r3"
}
]
}
}
],
"url": "http://hl7.org/fhir/4.3/StructureDefinition/profile-Binary",
"version": "0.1.0",
"name": "Profile_R4B_Binary_R3",
"title": "Cross-version Profile for R4B.Binary for use in FHIR STU3",
"status": "active",
"experimental": false,
"date": "2026-03-17T16:04:24.9655282-05:00",
"publisher": "FHIR Infrastructure",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "This cross-version profile allows R4B Binary content to be represented via FHIR STU3 Binary resources.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "Binary",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Binary",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Binary",
"path": "Binary",
"short": "Pure binary content defined by a format other than FHIR",
"definition": "A binary resource can contain any content, whether text, image, pdf, zip archive, etc.",
"comment": "Typically, Binary resources are used for handling content such as: * CDA Documents (i.e. with XDS) * PDF Documents * Images (the Media resource is preferred for handling images, but not possible when the content is already binary - e.g. XDS).",
"min": 0,
"max": "*",
"base": {
"path": "Binary",
"min": 0,
"max": "*"
},
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "w5",
"map": "infrastructure.structure"
}
]
},
{
"id": "Binary.id",
"path": "Binary.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "Binary.meta",
"path": "Binary.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "Binary.meta.id",
"path": "Binary.meta.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Binary.meta.extension",
"path": "Binary.meta.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Binary.meta.extension:meta",
"path": "Binary.meta.extension",
"sliceName": "meta",
"short": "R4B: meta additional types",
"definition": "R4B: `Binary.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)",
"comment": "Element `Binary.meta` is mapped to FHIR STU3 element `Binary.meta` as `SourceIsBroaderThanTarget`.\nThe mappings for `Binary.meta` do not cover the following types: Meta.\nThe mappings for `Binary.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Binary.meta|0.1.0"
}
]
},
{
"id": "Binary.meta.versionId",
"path": "Binary.meta.versionId",
"short": "Version specific identifier",
"definition": "The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.",
"comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.versionId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "Binary.meta.lastUpdated",
"path": "Binary.meta.lastUpdated",
"short": "When the resource version last changed",
"definition": "When the resource last changed - e.g. when the version changed.",
"comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.lastUpdated",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"isSummary": true
},
{
"id": "Binary.meta.profile",
"path": "Binary.meta.profile",
"short": "Profiles this resource claims to conform to",
"definition": "A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/STU3/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/STU3/).",
"comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.profile",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "Binary.meta.security",
"path": "Binary.meta.security",
"short": "Security Labels applied to this resource",
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"comment": "The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.security",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}
],
"strength": "extensible",
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels|3.0.2"
}
}
},
{
"id": "Binary.meta.tag",
"path": "Binary.meta.tag",
"short": "Tags applied to this resource",
"definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.tag",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
}
],
"strength": "example",
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/common-tags|3.0.2"
}
}
},
{
"id": "Binary.implicitRules",
"path": "Binary.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "Binary.language",
"path": "Binary.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages|3.0.2"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages|3.0.2"
}
}
},
{
"id": "Binary.contentType",
"path": "Binary.contentType",
"short": "MimeType of the binary content",
"definition": "MimeType of the binary content represented as a standard MimeType (BCP 13).",
"min": 1,
"max": "1",
"base": {
"path": "Binary.contentType",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
}
],
"strength": "required",
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"id": "Binary.securityContext",
"path": "Binary.securityContext",
"short": "Access Control Management",
"definition": "Treat this binary as if it was this other resource for access control purposes.",
"min": 0,
"max": "1",
"base": {
"path": "Binary.securityContext",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true
},
{
"id": "Binary.securityContext.id",
"path": "Binary.securityContext.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Binary.securityContext.extension",
"path": "Binary.securityContext.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Binary.securityContext.extension:securityContext",
"path": "Binary.securityContext.extension",
"sliceName": "securityContext",
"short": "R4B: Identifies another resource to use as proxy when enforcing access control additional types",
"definition": "R4B: `Binary.securityContext` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `Binary.securityContext` is mapped to FHIR STU3 element `Binary.securityContext` as `SourceIsBroaderThanTarget`.\nThe mappings for `Binary.securityContext` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `Binary.securityContext` with unmapped reference targets: Resource.\nVery often, a server will also know of a resource that references the binary, and can automatically apply the appropriate access rules based on that reference. However, there are some circumstances where this is not appropriate, e.g. the binary is uploaded directly to the server without any linking resource, the binary is referred to from multiple different resources, and/or the binary is content such as an application logo that has less protection than any of the resources that reference it.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "Binary.securityContext.reference",
"path": "Binary.securityContext.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Binary.securityContext.identifier",
"path": "Binary.securityContext.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "Binary.securityContext.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Binary.securityContext.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Binary.content",
"path": "Binary.content",
"short": "The actual content",
"definition": "The actual content, base64 encoded.",
"comment": "If the content type is itself base64 encoding, then this will be base64 encoded twice - what is created by un-base64ing the content must be the specified content type.",
"min": 1,
"max": "1",
"base": {
"path": "Binary.content",
"min": 1,
"max": "1"
},
"type": [
{
"code": "base64Binary"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Binary",
"path": "Binary"
},
{
"id": "Binary.meta.extension",
"path": "Binary.meta.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Binary.meta.extension:meta",
"path": "Binary.meta.extension",
"sliceName": "meta",
"short": "R4B: meta additional types",
"definition": "R4B: `Binary.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)",
"comment": "Element `Binary.meta` is mapped to FHIR STU3 element `Binary.meta` as `SourceIsBroaderThanTarget`.\nThe mappings for `Binary.meta` do not cover the following types: Meta.\nThe mappings for `Binary.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-Binary.meta|0.1.0"
}
]
},
{
"id": "Binary.securityContext.extension",
"path": "Binary.securityContext.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Binary.securityContext.extension:securityContext",
"path": "Binary.securityContext.extension",
"sliceName": "securityContext",
"short": "R4B: Identifies another resource to use as proxy when enforcing access control additional types",
"definition": "R4B: `Binary.securityContext` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `Binary.securityContext` is mapped to FHIR STU3 element `Binary.securityContext` as `SourceIsBroaderThanTarget`.\nThe mappings for `Binary.securityContext` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `Binary.securityContext` with unmapped reference targets: Resource.\nVery often, a server will also know of a resource that references the binary, and can automatically apply the appropriate access rules based on that reference. However, there are some circumstances where this is not appropriate, e.g. the binary is uploaded directly to the server without any linking resource, the binary is referred to from multiple different resources, and/or the binary is content such as an application logo that has less protection than any of the resources that reference it.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
}
]
}
}