US Core Organization
US Core Organization Core Profile (USCoreOrganization) | I | http://hl7.org/fhir/StructureDefinition/Organization | There are no (further) constraints on this element Element idOrganization:uscoreorganization US Core Organization Profile DefinitionA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc. http://hl7.org/fhir/StructureDefinition/Organization Constraints
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idOrganization:uscoreorganization.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. id |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idOrganization:uscoreorganization.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. Meta |
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idOrganization:uscoreorganization.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. uri |
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization:uscoreorganization.language Language of the resource content DefinitionThe base language in which the resource is written. 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). code BindingA human language. ?? (extensible) | |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idOrganization:uscoreorganization.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may 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. 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 in formation is added later. Narrative Mappings
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idOrganization:uscoreorganization.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Resource Mappings
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idOrganization:uscoreorganization.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Extension Mappings
| |
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idOrganization:uscoreorganization.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. 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. Extension Mappings
|
identifier | S Σ I | 1..* | Identifier | There are no (further) constraints on this element Element idOrganization:uscoreorganization.identifier Identifies this organization across multiple systems DefinitionIdentifier for the organization that is used to identify the organization across multiple disparate systems. Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. Identifier Mappings
|
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization:uscoreorganization.identifier.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string Mappings
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idOrganization:uscoreorganization.identifier.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization:uscoreorganization.identifier.use usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. code BindingIdentifies the purpose for this identifier, if known . ?? (required)Mappings
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization:uscoreorganization.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. CodeableConcept BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ?? (extensible)Mappings
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idOrganization:uscoreorganization.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. NPI preferred (http://hl7.org/fhir/sid/us-npi), Tax id is allowed (http://hl7.org/fhir/sid/us-tin), Local id is allowed in addition to 'authoritative' identifier. uri ExamplesGeneral http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri Mappings
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization:uscoreorganization.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. string ExamplesGeneral 123456 Mappings
|
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization:uscoreorganization.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. Period Mappings
|
assigner | Σ | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Organization) | There are no (further) constraints on this element Element idOrganization:uscoreorganization.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(http://hl7.org/fhir/StructureDefinition/Organization) Mappings
|
active | S Σ ?! | 1..1 | boolean | There are no (further) constraints on this element Element idOrganization:uscoreorganization.active Whether the organization's record is still in active use DefinitionWhether the organization's record is still in active use. Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI. Default is true. This active flag is not intended to be used to mark an organizations 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. This element is labeled as a modifier because it may be used to mark that the resource was created in error. boolean Default valuetrue
|
type | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idOrganization:uscoreorganization.type Kind of organization DefinitionThe kind(s) of organization that this is. Need to be able to track the kind of organization that this is - different organization types have different uses. 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 When 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. We expect that some jurisdictions will profile this optionality to be a single cardinality. CodeableConcept BindingUsed to categorize the organization ?? (example)Mappings
|
name | S Σ I | 1..1 | string | There are no (further) constraints on this element Element idOrganization:uscoreorganization.name Name used for the organization DefinitionA name associated with the organization. Need to use the name as the label of the organization. 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. string Mappings
|
alias | 0..* | string | There are no (further) constraints on this element Element idOrganization:uscoreorganization.alias A list of alternate names that the organization is known as, or was known as in the past DefinitionA list of alternate names that the organization is known as, or was known as in the past. Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful. 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. string Mappings
| |
telecom | S I | 1..* | ContactPoint | There are no (further) constraints on this element Element idOrganization:uscoreorganization.telecom A contact detail for the organization DefinitionA contact detail for the organization. Human contact for the organization. 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. ContactPoint Constraints
|
address | S I | 1..* | Address | There are no (further) constraints on this element Element idOrganization:uscoreorganization.address An address for the organization DefinitionAn address for the organization. May need to keep track of the organization's addresses for contacting, billing or reporting requirements. Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used. Address Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization:uscoreorganization.address.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string Mappings
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idOrganization:uscoreorganization.address.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization:uscoreorganization.address.use home | work | temp | old - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. code BindingThe use of an address ?? (required)Examples General home Mappings
|
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idOrganization:uscoreorganization.address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. code BindingThe type of an address (physical / postal) ?? (required)Examples General both Mappings
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization:uscoreorganization.address.text Text representation of the address DefinitionA full text representation of the address. A renderable, unencoded form. Can provide both a text representation and parts. string ExamplesGeneral 137 Nowhere Street, Erewhon 9132 Mappings
|
line | S Σ | 0..* | string | There are no (further) constraints on this element Element idOrganization:uscoreorganization.address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. home | work | temp | old - purpose of this address. string ExamplesGeneral 137 Nowhere Street Mappings
|
city | S Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization:uscoreorganization.address.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. string ExamplesGeneral Erewhon Mappings
|
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization:uscoreorganization.address.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). 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. string ExamplesGeneral Madison Mappings
|
state | S Σ | 0..1 | stringBinding | There are no (further) constraints on this element Element idOrganization:uscoreorganization.address.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). string BindingTwo letter USPS alphabetic codes. ?? (required)Mappings
|
postalCode | S Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization:uscoreorganization.address.postalCode US Zip Codes Alternate namesZip DefinitionA postal code designating a region defined by the postal service. string ExamplesGeneral 9132 Mappings
|
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idOrganization:uscoreorganization.address.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a full country name. string Mappings
|
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idOrganization:uscoreorganization.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. Period ExamplesGeneral { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
partOf | Σ | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Organization) | There are no (further) constraints on this element Element idOrganization:uscoreorganization.partOf The organization of which this organization forms a part DefinitionThe organization of which this organization forms a part. Need to be able to track the hierarchy of organizations within an organization. Reference(http://hl7.org/fhir/StructureDefinition/Organization) Mappings
|
contact | 0..* | BackboneElement | There are no (further) constraints on this element Element idOrganization:uscoreorganization.contact Contact for the organization for a certain purpose DefinitionContact for the organization for a certain purpose. Need to keep track of assigned contact points within bigger organization. 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. BackboneElement Constraints
| |
id | 0..1 | string | There are no (further) constraints on this element Element idOrganization:uscoreorganization.contact.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. string Mappings
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idOrganization:uscoreorganization.contact.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Mappings
| |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idOrganization:uscoreorganization.contact.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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 that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. 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. Extension Mappings
|
purpose | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idOrganization:uscoreorganization.contact.purpose The type of contact DefinitionIndicates a purpose for which the contact can be reached. Need to distinguish between multiple contact persons. CodeableConcept BindingThe purpose for which you would contact a contact party ?? (extensible)Mappings
| |
name | 0..1 | HumanName | There are no (further) constraints on this element Element idOrganization:uscoreorganization.contact.name A name associated with the contact DefinitionA name associated with the contact. Need to be able to track the person by name. HumanName Mappings
| |
telecom | 0..* | ContactPoint | There are no (further) constraints on this element Element idOrganization:uscoreorganization.contact.telecom Contact details (telephone, email, etc.) for a contact DefinitionA contact detail (e.g. a telephone number or an email address) by which the party may be contacted. People have (primary) ways to contact them in some way such as phone, email. ContactPoint Mappings
| |
address | 0..1 | Address | There are no (further) constraints on this element Element idOrganization:uscoreorganization.contact.address Visiting or postal addresses for the contact DefinitionVisiting or postal addresses for the contact. May need to keep track of a contact party's address for contacting, billing or reporting requirements. Address Mappings
| |
endpoint | S | 0..* | Reference(http://hl7.org/fhir/StructureDefinition/Endpoint) | There are no (further) constraints on this element Element idOrganization:uscoreorganization.endpoint Technical endpoints providing access to services operated for the organization DefinitionTechnical endpoints providing access to services operated for the organization. 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. Reference(http://hl7.org/fhir/StructureDefinition/Endpoint) Mappings
|