{
"description": "Organization-level Brand information.",
"_filename": "StructureDefinition-organization-brand.json",
"package_name": "hl7.fhir.uv.extensions.r3",
"date": "2023-10-02T15:38:12-05: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": "OrganizationBrand",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Extension",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Organization Brand",
"package_version": "5.3.0-ballot-tc",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
}, {
"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": "Organization-level Brand information.",
"short": "Organization Brand",
"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": 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.extension",
"min": 0,
"definition": "Brand logo URL. SHOULD be optimized for display as a 1 in / 2.54 cm square and formatted as SVG or 1024x1024 pixel PNG with transparent background. Logo should be be legible at small sizes (e.g., as small as 50x50 pixels). Tips to achieve this: if the logo contains both a brandmark and a wordmark, separate them and use just the brandmark. If the logo is predominantly horizontal, consider creating a vertically-oriented logo that is still recognizable when scaled to smaller sizes. Multiple logos may be supplied. The URL can be an absolute URL with the https:// schema, or a Data URL with the data: schema that directly embeds content. Additional resolutions can be supplied with repeated 'brandLogo' extensions.",
"short": "Brand Logo",
"type": [ {
"code": "Extension"
} ],
"sliceName": "brandLogo",
"max": "*",
"id": "Extension.extension:brandLogo",
"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:brandLogo.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:brandLogo.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": "brandLogo",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:brandLogo.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": "uri"
} ],
"max": "1",
"id": "Extension.extension:brandLogo.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"min": 0,
"definition": "The license type for the brand logo. Uses SPDX license identifier when available. See https://spdx.org/licenses/ for more information.",
"short": "Brand Logo License Type",
"type": [ {
"code": "Extension"
} ],
"sliceName": "brandLogoLicenseType",
"max": "*",
"id": "Extension.extension:brandLogoLicenseType",
"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:brandLogoLicenseType.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:brandLogoLicenseType.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": "brandLogoLicenseType",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:brandLogoLicenseType.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": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/spdx-license"
}
},
"max": "1",
"id": "Extension.extension:brandLogoLicenseType.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"min": 0,
"definition": "The license for the brand logo. This is a URL to the license details.",
"short": "Brand Logo License",
"type": [ {
"code": "Extension"
} ],
"sliceName": "brandLogoLicense",
"max": "*",
"id": "Extension.extension:brandLogoLicense",
"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:brandLogoLicense.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:brandLogoLicense.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": "brandLogoLicense",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:brandLogoLicense.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": "uri"
} ],
"max": "1",
"id": "Extension.extension:brandLogoLicense.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"min": 0,
"definition": "URL to an authoritative Brand Bundle where additional information about this Brand may be available",
"short": "Brand Bundle URL",
"type": [ {
"code": "Extension"
} ],
"sliceName": "brandBundle",
"max": "*",
"id": "Extension.extension:brandBundle",
"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:brandBundle.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:brandBundle.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": "brandBundle",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:brandBundle.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": "uri"
} ],
"max": "1",
"id": "Extension.extension:brandBundle.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/StructureDefinition/organization-brand",
"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": "0",
"id": "Extension.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
} ]
},
"status": "active",
"id": "180e7155-e2b2-4e72-aaa5-f3411f92a80b",
"kind": "complex-type",
"url": "http://hl7.org/fhir/StructureDefinition/organization-brand",
"identifier": [ {
"value": "urn:oid:2.16.840.1.113883.4.642.5.1499",
"system": "urn:ietf:rfc:3986"
} ],
"context": [ "Organization" ],
"version": "5.3.0-ballot-tc",
"differential": {
"element": [ {
"id": "Extension",
"path": "Extension",
"short": "Organization Brand",
"definition": "Organization-level Brand information."
}, {
"id": "Extension.extension:brandLogo",
"max": "*",
"min": 0,
"path": "Extension.extension",
"short": "Brand Logo",
"sliceName": "brandLogo",
"definition": "Brand logo URL. SHOULD be optimized for display as a 1 in / 2.54 cm square and formatted as SVG or 1024x1024 pixel PNG with transparent background. Logo should be be legible at small sizes (e.g., as small as 50x50 pixels). Tips to achieve this: if the logo contains both a brandmark and a wordmark, separate them and use just the brandmark. If the logo is predominantly horizontal, consider creating a vertically-oriented logo that is still recognizable when scaled to smaller sizes. Multiple logos may be supplied. The URL can be an absolute URL with the https:// schema, or a Data URL with the data: schema that directly embeds content. Additional resolutions can be supplied with repeated 'brandLogo' extensions."
}, {
"id": "Extension.extension:brandLogo.extension",
"max": "0",
"path": "Extension.extension.extension"
}, {
"id": "Extension.extension:brandLogo.url",
"path": "Extension.extension.url",
"fixedUri": "brandLogo"
}, {
"id": "Extension.extension:brandLogo.value[x]",
"path": "Extension.extension.value[x]",
"type": [ {
"code": "uri"
} ]
}, {
"id": "Extension.extension:brandLogoLicenseType",
"max": "*",
"min": 0,
"path": "Extension.extension",
"short": "Brand Logo License Type",
"sliceName": "brandLogoLicenseType",
"definition": "The license type for the brand logo. Uses SPDX license identifier when available. See https://spdx.org/licenses/ for more information."
}, {
"id": "Extension.extension:brandLogoLicenseType.extension",
"max": "0",
"path": "Extension.extension.extension"
}, {
"id": "Extension.extension:brandLogoLicenseType.url",
"path": "Extension.extension.url",
"fixedUri": "brandLogoLicenseType"
}, {
"id": "Extension.extension:brandLogoLicenseType.value[x]",
"path": "Extension.extension.value[x]",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/spdx-license"
}
}
}, {
"id": "Extension.extension:brandLogoLicense",
"max": "*",
"min": 0,
"path": "Extension.extension",
"short": "Brand Logo License",
"sliceName": "brandLogoLicense",
"definition": "The license for the brand logo. This is a URL to the license details."
}, {
"id": "Extension.extension:brandLogoLicense.extension",
"max": "0",
"path": "Extension.extension.extension"
}, {
"id": "Extension.extension:brandLogoLicense.url",
"path": "Extension.extension.url",
"fixedUri": "brandLogoLicense"
}, {
"id": "Extension.extension:brandLogoLicense.value[x]",
"path": "Extension.extension.value[x]",
"type": [ {
"code": "uri"
} ]
}, {
"id": "Extension.extension:brandBundle",
"max": "*",
"min": 0,
"path": "Extension.extension",
"short": "Brand Bundle URL",
"sliceName": "brandBundle",
"definition": "URL to an authoritative Brand Bundle where additional information about this Brand may be available"
}, {
"id": "Extension.extension:brandBundle.extension",
"max": "0",
"path": "Extension.extension.extension"
}, {
"id": "Extension.extension:brandBundle.url",
"path": "Extension.extension.url",
"fixedUri": "brandBundle"
}, {
"id": "Extension.extension:brandBundle.value[x]",
"path": "Extension.extension.value[x]",
"type": [ {
"code": "uri"
} ]
}, {
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/organization-brand"
}, {
"id": "Extension.value[x]",
"max": "0",
"path": "Extension.value[x]"
} ]
},
"contact": [ {
"name": "HL7 FHIR Infrastructure WG",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"contextType": "resource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension"
}