{
"description": "This profile builds upon the US Core Organization profile. It is used to convey a payer, provider, payee or service facility organization.",
"_filename": "StructureDefinition-C4BB-Organization.json",
"package_name": "hl7.fhir.us.carin-bb",
"date": "2024-07-27T20:09:37+08:00",
"derivation": "constraint",
"publisher": "HL7 International / Financial Management",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "C4BBOrganization",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD",
"identity": "servd"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
} ],
"abstract": false,
"type": "Organization",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "C4BB Organization",
"package_version": "2.1.0-snapshot1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-compliesWithProfile",
"valueCanonical": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|3.1.1"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fm"
}, {
"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/us/carin-bb/ImplementationGuide/hl7.fhir.us.carin-bb"
} ]
}
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
}, {
"key": "org-1",
"human": "The organization SHALL at least have a name or an identifier, and possibly more than one",
"xpath": "count(f:identifier | f:name) > 0",
"source": "http://hl7.org/fhir/StructureDefinition/Organization",
"severity": "error",
"expression": "(identifier.count() + name.count()) > 0"
}, {
"key": "uncontained-requires-lastUpdated",
"human": "meta.lastUpdated required if not a contained resource",
"source": "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization",
"severity": "error",
"expression": "%resource = %rootResource implies meta.lastUpdated.exists()"
} ],
"path": "Organization",
"min": 0,
"definition": "\\-",
"isModifier": false,
"short": "A grouping of people or organizations with a common purpose",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "(also see master files messages)",
"identity": "v2"
}, {
"map": "Organization(classCode=ORG, determinerCode=INST)",
"identity": "rim"
}, {
"map": "Organization",
"identity": "servd"
} ],
"mustSupport": false,
"max": "*",
"id": "Organization",
"comment": "\\-",
"base": {
"max": "*",
"min": 0,
"path": "Organization"
},
"isSummary": false
}, {
"path": "Organization.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"max": "1",
"id": "Organization.id",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.meta",
"min": 1,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"mustSupport": true,
"max": "1",
"id": "Organization.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Organization.meta.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": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Organization.meta.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"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() or (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": "Organization.meta.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 manageable, 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": "Organization.meta.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
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.meta.versionId",
"min": 0,
"definition": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.",
"isModifier": false,
"short": "Version specific identifier",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Organization.meta.versionId",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.versionId"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.meta.lastUpdated",
"min": 0,
"definition": "When the resource last changed - e.g. when the version changed.",
"isModifier": false,
"short": "When the resource version last changed",
"type": [ {
"code": "instant"
} ],
"mustSupport": true,
"max": "1",
"id": "Organization.meta.lastUpdated",
"comment": "Defines the date the Resource was created or updated, whichever comes last (163). Payers SHALL provide the last time the data was updated or the date of creation in the payer’s system of record, whichever comes last. Apps will use the meta.lastUpdated value to determine if the Reference resources are as of the current date or date of service. lastUpdated required unless the Resource is \"contained\"",
"base": {
"max": "1",
"min": 0,
"path": "Meta.lastUpdated"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.meta.source",
"min": 0,
"definition": "A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.",
"isModifier": false,
"short": "Identifies where the resource comes from",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Organization.meta.source",
"comment": "In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. \n\nThis element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.source"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.meta.profile",
"min": 1,
"definition": "A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).",
"isModifier": false,
"short": "Profiles this resource claims to conform to",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ]
} ],
"max": "*",
"id": "Organization.meta.profile",
"comment": "meta.profile is required as a matter of convenience of receiving systems. The meta.profile should be used by the Server to hint/assert/declare that this instance conforms to one (or more) stated profiles (with business versions). meta.profile does not capture any business logic, processing directives, or semantics (for example, inpatient or outpatient). Clients should not assume that the Server will exhaustively indicate all profiles with all versions that this instance conforms to. Clients can (and should) perform their own validation of conformance to the indicated profile(s) and to any other profiles of interest. CPCDS data element (190)",
"base": {
"max": "*",
"min": 0,
"path": "Meta.profile"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.meta.security",
"min": 0,
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"isModifier": false,
"short": "Security Labels applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/security-labels",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System."
},
"max": "*",
"id": "Organization.meta.security",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.security"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.meta.tag",
"min": 0,
"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.",
"isModifier": false,
"short": "Tags applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/common-tags",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
} ],
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"."
},
"max": "*",
"id": "Organization.meta.tag",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.tag"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.implicitRules",
"min": 0,
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Organization.implicitRules",
"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"description": "A human language."
},
"max": "1",
"id": "Organization.language",
"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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Organization.text",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "Organization.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Organization.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"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() or (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": "Organization.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. 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 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"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Organization.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": "DomainResource.extension"
},
"isSummary": false
}, {
"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() or (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": "Organization.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Organization.modifierExtension",
"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": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.identifier",
"requirements": "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min": 0,
"definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"isModifier": false,
"short": "Identifies this organization across multiple systems",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "XON.10 / XON.3",
"identity": "v2"
}, {
"map": ".scopes[Role](classCode=IDENT)",
"identity": "rim"
}, {
"map": "./Identifiers",
"identity": "servd"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "pattern"
} ]
},
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "*",
"id": "Organization.identifier",
"condition": [ "org-1" ],
"comment": "NPI preferred.",
"base": {
"max": "*",
"min": 0,
"path": "Organization.identifier"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
}, {
"key": "us-core-16",
"human": "NPI must be 10 digits",
"xpath": "f:value/f:matches(value,/^[0-9]{10}$/)",
"source": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization",
"severity": "error",
"expression": "value.matches('^[0-9]{10}$')"
}, {
"key": "us-core-17",
"human": "NPI check digit must be valid (Luhn algorithm check)",
"source": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization",
"severity": "error",
"expression": "(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)"
} ],
"path": "Organization.identifier",
"requirements": "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min": 0,
"definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"isModifier": false,
"short": "National Provider Identifier (NPI)",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "XON.10 / XON.3",
"identity": "v2"
}, {
"map": ".scopes[Role](classCode=IDENT)",
"identity": "rim"
}, {
"map": "./Identifiers",
"identity": "servd"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"sliceName": "NPI",
"patternIdentifier": {
"type": {
"coding": [ {
"code": "NPI",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
} ]
},
"system": "http://hl7.org/fhir/sid/us-npi"
},
"max": "*",
"id": "Organization.identifier:NPI",
"condition": [ "org-1", "us-core-16", "us-core-17" ],
"comment": "The National Provider Identifier assigned to the Billing Provider, Care Team members and the Service Facility (93, 94, 95, 97, 99, 100, 122, 173). Service Facility NPI will be populated with the value 'NPI has not been assigned' if an NPI has not been assigned to the Service Location Organization",
"base": {
"max": "*",
"min": 0,
"path": "Organization.identifier"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
}, {
"key": "us-core-18",
"human": "CLIA number must be 10 digits with a letter \"D\" in third position",
"xpath": "f:value/f:matches(value,/^[0-9]{2}D[0-9]{7}$/)",
"severity": "error",
"expression": "value.matches('^[0-9]{2}D[0-9]{7}$')"
} ],
"path": "Organization.identifier",
"requirements": "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min": 0,
"definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"isModifier": false,
"short": "Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "XON.10 / XON.3",
"identity": "v2"
}, {
"map": ".scopes[Role](classCode=IDENT)",
"identity": "rim"
}, {
"map": "./Identifiers",
"identity": "servd"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"sliceName": "CLIA",
"patternIdentifier": {
"system": "urn:oid:2.16.840.1.113883.4.7"
},
"max": "*",
"id": "Organization.identifier:CLIA",
"condition": [ "org-1", "us-core-18" ],
"base": {
"max": "*",
"min": 0,
"path": "Organization.identifier"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
}, {
"key": "us-core-19",
"human": "NAIC must be 5 digits",
"xpath": "f:value/f:matches(value,/^[0-9]{5}$/)",
"source": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization",
"severity": "error",
"expression": "value.matches('^[0-9]{5}$')"
} ],
"path": "Organization.identifier",
"requirements": "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min": 0,
"definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"isModifier": false,
"short": "NAIC Code",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "XON.10 / XON.3",
"identity": "v2"
}, {
"map": ".scopes[Role](classCode=IDENT)",
"identity": "rim"
}, {
"map": "./Identifiers",
"identity": "servd"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"sliceName": "NAIC",
"patternIdentifier": {
"type": {
"coding": [ {
"code": "naiccode",
"system": "http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType"
} ]
},
"system": "urn:oid:2.16.840.1.113883.6.300"
},
"max": "*",
"id": "Organization.identifier:NAIC",
"condition": [ "org-1", "us-core-19" ],
"comment": "NAIC Code of the payer responsible for the claim (2)",
"base": {
"max": "*",
"min": 0,
"path": "Organization.identifier"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.identifier",
"requirements": "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min": 0,
"definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"isModifier": false,
"short": "Tax ID Number",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "XON.10 / XON.3",
"identity": "v2"
}, {
"map": ".scopes[Role](classCode=IDENT)",
"identity": "rim"
}, {
"map": "./Identifiers",
"identity": "servd"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"sliceName": "tax",
"patternIdentifier": {
"type": {
"coding": [ {
"code": "TAX",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
} ]
},
"system": "urn:oid:2.16.840.1.113883.4.4"
},
"max": "*",
"id": "Organization.identifier:tax",
"condition": [ "org-1" ],
"comment": "Tax ID Number",
"base": {
"max": "*",
"min": 0,
"path": "Organization.identifier"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.identifier",
"requirements": "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min": 0,
"definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"isModifier": false,
"short": "Payer ID used in HIPAA covered claims submission transactions",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "XON.10 / XON.3",
"identity": "v2"
}, {
"map": ".scopes[Role](classCode=IDENT)",
"identity": "rim"
}, {
"map": "./Identifiers",
"identity": "servd"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"sliceName": "payerid",
"patternIdentifier": {
"type": {
"coding": [ {
"code": "payerid",
"system": "http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType"
} ]
}
},
"max": "*",
"id": "Organization.identifier:payerid",
"condition": [ "org-1" ],
"comment": "Internal value assigned by the payer responsible for the claim (2)",
"base": {
"max": "*",
"min": 0,
"path": "Organization.identifier"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.active",
"requirements": "Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.",
"min": 1,
"definition": "Whether the organization's record is still in active use.",
"isModifier": true,
"short": "Whether the organization's record is still in active use",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "No equivalent in HL7 v2",
"identity": "v2"
}, {
"map": ".status",
"identity": "rim"
}, {
"map": "./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.",
"identity": "servd"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": true,
"meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element",
"max": "1",
"id": "Organization.active",
"comment": "This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.\n\nThis element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"base": {
"max": "1",
"min": 0,
"path": "Organization.active"
},
"isModifierReason": "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.type",
"requirements": "Need to be able to track the kind of organization that this is - different organization types have different uses.",
"min": 0,
"definition": "The kind(s) of organization that this is.",
"isModifier": false,
"short": "Kind of organization",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "No equivalent in v2",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "n/a",
"identity": "servd"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/organization-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "OrganizationType"
} ],
"description": "Used to categorize the organization."
},
"max": "*",
"id": "Organization.type",
"comment": "Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes\n\nWhen considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.\n\nWe expect that some jurisdictions will profile this optionality to be a single cardinality.",
"base": {
"max": "*",
"min": 0,
"path": "Organization.type"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.name",
"requirements": "Need to use the name as the label of the organization.",
"min": 1,
"definition": "A name associated with the organization.",
"isModifier": false,
"short": "Name used for the organization",
"mapping": [ {
"map": "XON.1",
"identity": "v2"
}, {
"map": ".name",
"identity": "rim"
}, {
"map": ".PreferredName/Name",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Organization.name",
"condition": [ "org-1" ],
"comment": "If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.",
"base": {
"max": "1",
"min": 0,
"path": "Organization.name"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.alias",
"requirements": "Over time locations and organizations go through many changes and can be known by different names.\n\nFor searching knowing previous names that the organization was known by can be very useful.",
"min": 0,
"definition": "A list of alternate names that the organization is known as, or was known as in the past.",
"isModifier": false,
"short": "A list of alternate names that the organization is known as, or was known as in the past",
"mapping": [ {
"map": ".name",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Organization.alias",
"comment": "There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.",
"base": {
"max": "*",
"min": 0,
"path": "Organization.alias"
},
"isSummary": false
}, {
"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() or (children().count() > id.count())"
}, {
"key": "org-3",
"human": "The telecom of an organization can never be of use 'home'",
"xpath": "count(f:use[@value='home']) = 0",
"source": "http://hl7.org/fhir/StructureDefinition/Organization",
"severity": "error",
"expression": "where(use = 'home').empty()"
} ],
"path": "Organization.telecom",
"requirements": "Human contact for the organization.",
"min": 0,
"definition": "A contact detail for the organization.",
"isModifier": false,
"short": "A contact detail for the organization",
"mapping": [ {
"map": "ORC-22?",
"identity": "v2"
}, {
"map": ".telecom",
"identity": "rim"
}, {
"map": "./ContactPoints",
"identity": "servd"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"mustSupport": true,
"max": "*",
"id": "Organization.telecom",
"condition": [ "org-3" ],
"comment": "The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.",
"base": {
"max": "*",
"min": 0,
"path": "Organization.telecom"
},
"isSummary": false
}, {
"path": "Organization.telecom.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": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Organization.telecom.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"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() or (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": "Organization.telecom.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 manageable, 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": "Organization.telecom.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
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.telecom.system",
"min": 0,
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"isModifier": false,
"short": "phone | fax | email | pager | url | sms | other",
"mapping": [ {
"map": "XTN.3",
"identity": "v2"
}, {
"map": "./scheme",
"identity": "rim"
}, {
"map": "./ContactPointType",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointSystem"
} ],
"description": "Telecommunications form for contact point."
},
"max": "1",
"id": "Organization.telecom.system",
"condition": [ "cpt-2" ],
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.system"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.telecom.value",
"requirements": "Need to support legacy numbers that are not in a tightly controlled format.",
"min": 0,
"definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"isModifier": false,
"short": "The actual contact point details",
"mapping": [ {
"map": "XTN.1 (or XTN.12)",
"identity": "v2"
}, {
"map": "./url",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Organization.telecom.value",
"comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.value"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.telecom.use",
"requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
"min": 0,
"definition": "Identifies the purpose for the contact point.",
"isModifier": true,
"short": "home | work | temp | old | mobile - purpose of this contact point",
"mapping": [ {
"map": "XTN.2 - but often indicated by field",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./ContactPointPurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointUse"
} ],
"description": "Use of contact point."
},
"max": "1",
"id": "Organization.telecom.use",
"comment": "Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one",
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.telecom.rank",
"min": 0,
"definition": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.",
"isModifier": false,
"short": "Specify preferred order of use (1 = highest)",
"mapping": [ {
"map": "n/a",
"identity": "v2"
}, {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "Organization.telecom.rank",
"comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.rank"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.telecom.period",
"min": 0,
"definition": "Time period when the contact point was/is in use.",
"isModifier": false,
"short": "Time period when the contact point was/is in use",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Organization.telecom.period",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.period"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
}, {
"key": "org-2",
"human": "An address of an organization can never be of use 'home'",
"xpath": "count(f:use[@value='home']) = 0",
"source": "http://hl7.org/fhir/StructureDefinition/Organization",
"severity": "error",
"expression": "where(use = 'home').empty()"
} ],
"path": "Organization.address",
"requirements": "May need to keep track of the organization's addresses for contacting, billing or reporting requirements.",
"min": 0,
"definition": "An address for the organization.",
"isModifier": false,
"short": "An address for the organization",
"mapping": [ {
"map": "ORC-23?",
"identity": "v2"
}, {
"map": ".address",
"identity": "rim"
}, {
"map": "./PrimaryAddress and ./OtherAddresses",
"identity": "servd"
} ],
"type": [ {
"code": "Address"
} ],
"mustSupport": true,
"max": "*",
"id": "Organization.address",
"condition": [ "org-2" ],
"comment": "Enter address of the location where the services were rendered. If the location is a component of the Billing Provider, do not populate this data element",
"base": {
"max": "*",
"min": 0,
"path": "Organization.address"
},
"isSummary": false
}, {
"path": "Organization.address.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": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Organization.address.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"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() or (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": "Organization.address.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 manageable, 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": "Organization.address.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
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.address.use",
"requirements": "Allows an appropriate address to be chosen from a list of many.",
"min": 0,
"definition": "The purpose of this address.",
"isModifier": true,
"short": "home | work | temp | old | billing - purpose of this address",
"mapping": [ {
"map": "XAD.7",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./AddressPurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/address-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AddressUse"
} ],
"description": "The use of an address."
},
"max": "1",
"id": "Organization.address.use",
"comment": "Applications can assume that an address is current unless it explicitly says that it is temporary or old.",
"example": [ {
"label": "General",
"valueCode": "home"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one",
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.address.type",
"min": 0,
"definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.",
"isModifier": false,
"short": "postal | physical | both",
"mapping": [ {
"map": "XAD.18",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "address type parameter",
"identity": "vcard"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/address-type|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AddressType"
} ],
"description": "The type of an address (physical / postal)."
},
"max": "1",
"id": "Organization.address.type",
"comment": "The definition of Address states that \"address is intended to describe postal addresses, not physical locations\". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](http://hl7.org/fhir/R4/location.html#) resource).",
"example": [ {
"label": "General",
"valueCode": "both"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.type"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.address.text",
"requirements": "A renderable, unencoded form.",
"min": 0,
"definition": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.",
"isModifier": false,
"short": "Text representation of the address",
"mapping": [ {
"map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6",
"identity": "v2"
}, {
"map": "./formatted",
"identity": "rim"
}, {
"map": "address label parameter",
"identity": "vcard"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Organization.address.text",
"comment": "Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.",
"example": [ {
"label": "General",
"valueString": "137 Nowhere Street, Erewhon 9132"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.text"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.address.line",
"min": 0,
"definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.",
"isModifier": false,
"short": "Street name, number, direction & P.O. Box etc.",
"mapping": [ {
"map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)",
"identity": "v2"
}, {
"map": "AD.part[parttype = AL]",
"identity": "rim"
}, {
"map": "street",
"identity": "vcard"
}, {
"map": "./StreetAddress (newline delimitted)",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "4",
"id": "Organization.address.line",
"example": [ {
"label": "General",
"valueString": "137 Nowhere Street"
} ],
"orderMeaning": "The order in which lines should appear in an address label",
"base": {
"max": "*",
"min": 0,
"path": "Address.line"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.address.city",
"min": 0,
"definition": "The name of the city, town, suburb, village or other community or delivery center.",
"isModifier": false,
"short": "Name of city, town etc.",
"mapping": [ {
"map": "XAD.3",
"identity": "v2"
}, {
"map": "AD.part[parttype = CTY]",
"identity": "rim"
}, {
"map": "locality",
"identity": "vcard"
}, {
"map": "./Jurisdiction",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"alias": [ "Municpality" ],
"max": "1",
"id": "Organization.address.city",
"example": [ {
"label": "General",
"valueString": "Erewhon"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.city"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.address.district",
"min": 0,
"definition": "The name of the administrative area (county).",
"isModifier": false,
"short": "District name (aka county)",
"mapping": [ {
"map": "XAD.9",
"identity": "v2"
}, {
"map": "AD.part[parttype = CNT | CPA]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "County" ],
"max": "1",
"id": "Organization.address.district",
"comment": "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.",
"example": [ {
"label": "General",
"valueString": "Madison"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.district"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.address.state",
"min": 0,
"definition": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).",
"isModifier": false,
"short": "Sub-unit of country (abbreviations ok)",
"mapping": [ {
"map": "XAD.4",
"identity": "v2"
}, {
"map": "AD.part[parttype = STA]",
"identity": "rim"
}, {
"map": "region",
"identity": "vcard"
}, {
"map": "./Region",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state",
"description": "Two letter USPS alphabetic codes."
},
"alias": [ "Province", "Territory" ],
"max": "1",
"id": "Organization.address.state",
"base": {
"max": "1",
"min": 0,
"path": "Address.state"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.address.postalCode",
"min": 0,
"definition": "A postal code designating a region defined by the postal service.",
"isModifier": false,
"short": "US Zip Codes",
"mapping": [ {
"map": "XAD.5",
"identity": "v2"
}, {
"map": "AD.part[parttype = ZIP]",
"identity": "rim"
}, {
"map": "code",
"identity": "vcard"
}, {
"map": "./PostalIdentificationCode",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"alias": [ "Zip" ],
"max": "1",
"id": "Organization.address.postalCode",
"example": [ {
"label": "General",
"valueString": "9132"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.postalCode"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.address.country",
"min": 0,
"definition": "Country - a nation as commonly understood or generally accepted.",
"isModifier": false,
"short": "Country (e.g. can be ISO 3166 2 or 3 letter code)",
"mapping": [ {
"map": "XAD.6",
"identity": "v2"
}, {
"map": "AD.part[parttype = CNT]",
"identity": "rim"
}, {
"map": "country",
"identity": "vcard"
}, {
"map": "./Country",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Organization.address.country",
"comment": "ISO 3166 3 letter codes can be used in place of a human readable country name.",
"base": {
"max": "1",
"min": 0,
"path": "Address.country"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.address.period",
"requirements": "Allows addresses to be placed in historical context.",
"min": 0,
"definition": "Time period when address was/is in use.",
"isModifier": false,
"short": "Time period when address was/is in use",
"mapping": [ {
"map": "XAD.12 / XAD.13 + XAD.14",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Organization.address.period",
"example": [ {
"label": "General",
"valuePeriod": {
"end": "2010-07-01",
"start": "2010-03-23"
}
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.period"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.partOf",
"requirements": "Need to be able to track the hierarchy of organizations within an organization.",
"min": 0,
"definition": "The organization of which this organization forms a part.",
"isModifier": false,
"short": "The organization of which this organization forms a part",
"mapping": [ {
"map": "No equivalent in HL7 v2",
"identity": "v2"
}, {
"map": ".playedBy[classCode=Part].scoper",
"identity": "rim"
}, {
"map": "n/a",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean": true
} ],
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "Organization.partOf",
"base": {
"max": "1",
"min": 0,
"path": "Organization.partOf"
},
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.contact",
"requirements": "Need to keep track of assigned contact points within bigger organization.",
"min": 0,
"definition": "Contact for the organization for a certain purpose.",
"isModifier": false,
"short": "Contact for the organization for a certain purpose",
"mapping": [ {
"map": ".contactParty",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Organization.contact",
"comment": "Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.",
"base": {
"max": "*",
"min": 0,
"path": "Organization.contact"
},
"isSummary": false
}, {
"path": "Organization.contact.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": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Organization.contact.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"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() or (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": "Organization.contact.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 manageable, 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"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Organization.contact.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
}, {
"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() or (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": "Organization.contact.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Organization.contact.modifierExtension",
"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": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.contact.purpose",
"requirements": "Need to distinguish between multiple contact persons.",
"min": 0,
"definition": "Indicates a purpose for which the contact can be reached.",
"isModifier": false,
"short": "The type of contact",
"mapping": [ {
"map": "./type",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/contactentity-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPartyType"
} ],
"description": "The purpose for which you would contact a contact party."
},
"max": "1",
"id": "Organization.contact.purpose",
"base": {
"max": "1",
"min": 0,
"path": "Organization.contact.purpose"
},
"isSummary": false
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.contact.name",
"requirements": "Need to be able to track the person by name.",
"min": 0,
"definition": "A name associated with the contact.",
"isModifier": false,
"short": "A name associated with the contact",
"mapping": [ {
"map": "PID-5, PID-9",
"identity": "v2"
}, {
"map": "./name",
"identity": "rim"
} ],
"type": [ {
"code": "HumanName"
} ],
"max": "1",
"id": "Organization.contact.name",
"base": {
"max": "1",
"min": 0,
"path": "Organization.contact.name"
},
"isSummary": false
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.contact.telecom",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"definition": "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.",
"isModifier": false,
"short": "Contact details (telephone, email, etc.) for a contact",
"mapping": [ {
"map": "PID-13, PID-14",
"identity": "v2"
}, {
"map": "./telecom",
"identity": "rim"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"max": "*",
"id": "Organization.contact.telecom",
"base": {
"max": "*",
"min": 0,
"path": "Organization.contact.telecom"
},
"isSummary": false
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.contact.address",
"requirements": "May need to keep track of a contact party's address for contacting, billing or reporting requirements.",
"min": 0,
"definition": "Visiting or postal addresses for the contact.",
"isModifier": false,
"short": "Visiting or postal addresses for the contact",
"mapping": [ {
"map": "PID-11",
"identity": "v2"
}, {
"map": "./addr",
"identity": "rim"
} ],
"type": [ {
"code": "Address"
} ],
"max": "1",
"id": "Organization.contact.address",
"base": {
"max": "1",
"min": 0,
"path": "Organization.contact.address"
},
"isSummary": false
}, {
"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() or (children().count() > id.count())"
} ],
"path": "Organization.endpoint",
"requirements": "Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.",
"min": 0,
"definition": "Technical endpoints providing access to services operated for the organization.",
"isModifier": false,
"short": "Technical endpoints providing access to services operated for the organization",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Endpoint" ]
} ],
"max": "*",
"id": "Organization.endpoint",
"base": {
"max": "*",
"min": 0,
"path": "Organization.endpoint"
},
"isSummary": false
} ]
},
"status": "active",
"id": "cd388e40-b3ee-4ad5-aa81-5a4fd1ad2afe",
"kind": "resource",
"url": "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization",
"version": "2.1.0-snapshot1",
"differential": {
"element": [ {
"id": "Organization",
"path": "Organization",
"constraint": [ {
"key": "uncontained-requires-lastUpdated",
"human": "meta.lastUpdated required if not a contained resource",
"source": "http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization",
"severity": "error",
"expression": "%resource = %rootResource implies meta.lastUpdated.exists()"
} ]
}, {
"id": "Organization.meta",
"min": 1,
"path": "Organization.meta",
"mustSupport": true
}, {
"id": "Organization.meta.lastUpdated",
"path": "Organization.meta.lastUpdated",
"comment": "Defines the date the Resource was created or updated, whichever comes last (163). Payers SHALL provide the last time the data was updated or the date of creation in the payer’s system of record, whichever comes last. Apps will use the meta.lastUpdated value to determine if the Reference resources are as of the current date or date of service. lastUpdated required unless the Resource is \"contained\"",
"mustSupport": true
}, {
"id": "Organization.meta.profile",
"min": 1,
"path": "Organization.meta.profile",
"comment": "meta.profile is required as a matter of convenience of receiving systems. The meta.profile should be used by the Server to hint/assert/declare that this instance conforms to one (or more) stated profiles (with business versions). meta.profile does not capture any business logic, processing directives, or semantics (for example, inpatient or outpatient). Clients should not assume that the Server will exhaustively indicate all profiles with all versions that this instance conforms to. Clients can (and should) perform their own validation of conformance to the indicated profile(s) and to any other profiles of interest. CPCDS data element (190)"
}, {
"id": "Organization.identifier:NPI",
"path": "Organization.identifier",
"comment": "The National Provider Identifier assigned to the Billing Provider, Care Team members and the Service Facility (93, 94, 95, 97, 99, 100, 122, 173). Service Facility NPI will be populated with the value 'NPI has not been assigned' if an NPI has not been assigned to the Service Location Organization",
"sliceName": "NPI",
"patternIdentifier": {
"type": {
"coding": [ {
"code": "NPI",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
} ]
},
"system": "http://hl7.org/fhir/sid/us-npi"
}
}, {
"id": "Organization.identifier:NAIC",
"path": "Organization.identifier",
"comment": "NAIC Code of the payer responsible for the claim (2)",
"sliceName": "NAIC",
"mustSupport": true,
"patternIdentifier": {
"type": {
"coding": [ {
"code": "naiccode",
"system": "http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType"
} ]
},
"system": "urn:oid:2.16.840.1.113883.6.300"
}
}, {
"path": "Organization.identifier",
"min": 0,
"short": "Tax ID Number",
"mustSupport": true,
"sliceName": "tax",
"patternIdentifier": {
"type": {
"coding": [ {
"code": "TAX",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
} ]
},
"system": "urn:oid:2.16.840.1.113883.4.4"
},
"max": "*",
"id": "Organization.identifier:tax",
"comment": "Tax ID Number"
}, {
"path": "Organization.identifier",
"min": 0,
"short": "Payer ID used in HIPAA covered claims submission transactions",
"mustSupport": true,
"sliceName": "payerid",
"patternIdentifier": {
"type": {
"coding": [ {
"code": "payerid",
"system": "http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType"
} ]
}
},
"max": "*",
"id": "Organization.identifier:payerid",
"comment": "Internal value assigned by the payer responsible for the claim (2)"
}, {
"id": "Organization.address",
"path": "Organization.address",
"comment": "Enter address of the location where the services were rendered. If the location is a component of the Billing Provider, do not populate this data element"
} ]
},
"contact": [ {
"name": "HL7 International / Financial Management",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fm",
"system": "url"
}, {
"value": "fm@lists.HL7.org",
"system": "email"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
}