National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot United States of America flag

National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions

Resource Profile: NdhOrganization - Detailed Descriptions

Active as of 2024-06-17

Definitions for the ndh-Organization resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Organization
2. Organization.meta
4. Organization.meta.lastUpdated
Control1..?
6. Organization.extension
SlicingThis element introduces a set of slices on Organization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. Organization.extension:rating
    Slice Namerating
    Control0..*
    TypeExtension(NDH Rating) (Complex Extension)
    10. Organization.extension:paymentaccepted
    Slice Namepaymentaccepted
    Control0..*
    TypeExtension(NDH Payment Accepted) (Extension Type: CodeableConcept)
    12. Organization.extension:fundingSource
    Slice NamefundingSource
    Control0..*
    TypeExtension(NDH Funding Source) (Complex Extension)
    14. Organization.extension:org-description
    Slice Nameorg-description
    ShortOrganization Description
    Control0..1
    TypeExtension(NDH Org Description) (Extension Type: string)
    16. Organization.extension:digitalcertificate
    Slice Namedigitalcertificate
    ShortDigital Certificate
    Control0..*
    TypeExtension(NDH Digitalcertificate) (Complex Extension)
    18. Organization.extension:qualification
    Slice Namequalification
    ShortQualification
    Control0..*
    TypeExtension(NDH Qualification) (Complex Extension)
    20. Organization.extension:usage-restriction
    Slice Nameusage-restriction
    ShortUsage Restriction
    Control0..*
    TypeExtension(NDH Usage Restriction) (Extension Type: Reference(NDH Base Restriction)contained)
    22. Organization.extension:insuranceplan
    Slice Nameinsuranceplan
    ShortInsurance plan(s) offered to the organization's employees
    Control0..*
    TypeExtension(NDH InsurancePlan Reference) (Extension Type: Reference(NDH Base InsurancePlan Profile))
    24. Organization.extension:verification-status
    Slice Nameverification-status
    Control0..1
    TypeExtension(NDH Verification Status) (Extension Type: CodeableConcept)
    26. Organization.extension:logo
    Slice Namelogo
    Control0..1
    TypeExtension(NDH Logo) (Extension Type: Attachment)
    28. Organization.identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    30. Organization.identifier.extension:identifier-status
    Slice Nameidentifier-status
    Control0..1
    TypeExtension(NDH Identifier Status) (Extension Type: code)
    32. Organization.identifier.assigner
    TypeReference(NDH Base Organization Profile)
    34. Organization.identifier:TID
    Slice NameTID
    ShortTax Identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    Pattern Value{
      "system" : "http://hl7.org.fhir/sid/us-ssn"
    }
    36. Organization.active
    Pattern Valuetrue
    38. Organization.type
    Control1..?
    BindingUnless not suitable, these codes SHALL be taken from Organization Type Value Set
    (extensible to http://hl7.org/fhir/us/ndh/ValueSet/OrgTypeVS)
    Must Supporttrue
    40. Organization.alias
    Must Supporttrue
    42. Organization.alias.extension
    SlicingThis element introduces a set of slices on Organization.alias.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 44. Organization.alias.extension:org-alias-type
      Slice Nameorg-alias-type
      ShortOrganization Alias Type
      Control0..1
      TypeExtension(NDH Organization Alias Type) (Extension Type: CodeableConcept)
      46. Organization.alias.extension:org-alias-period
      Slice Nameorg-alias-period
      ShortOrganization Alias Period
      Control0..1
      TypeExtension(NDH Organization Alias Period) (Extension Type: Period)
      48. Organization.telecom
      50. Organization.telecom.extension:contactpoint-availabletime
      Slice Namecontactpoint-availabletime
      Control0..*
      TypeExtension(NDH Contactpoint Availabletime) (Complex Extension)
      52. Organization.telecom.extension:via-intermediary
      Slice Namevia-intermediary
      ShortVia Intermediary
      Control0..1
      TypeExtension(NDH Via Intermediary) (Extension Type: Reference(NDH Base PractitionerRole, NDH Base OrganizationAffiliation Profile, NDH Base Location Profile, NDH Base Organization Profile))
      54. Organization.telecom.extension:language-speak
      Slice Namelanguage-speak
      ShortLanguage Speak
      Control0..*
      TypeExtension(NDH Language Speak) (Extension Type: code)
      56. Organization.address
      58. Organization.address.extension:geolocation
      Slice Namegeolocation
      Control0..1
      TypeExtension(Geolocation) (Complex Extension)
      60. Organization.partOf
      TypeReference(NDH Base Organization Profile)
      62. Organization.contact
      64. Organization.contact.telecom
      66. Organization.contact.telecom.extension:contactpoint-availabletime
      Slice Namecontactpoint-availabletime
      Control0..*
      TypeExtension(NDH Contactpoint Availabletime) (Complex Extension)
      68. Organization.contact.telecom.extension:via-intermediary
      Slice Namevia-intermediary
      ShortVia Intermediary
      Control0..1
      TypeExtension(NDH Via Intermediary) (Extension Type: Reference(NDH Base PractitionerRole, NDH Base OrganizationAffiliation Profile, NDH Base Location Profile, NDH Base Organization Profile))
      70. Organization.endpoint
      TypeReference(NDH Base Endpoint Profile)
      Must Supporttrue

      Guidance on how to interpret the contents of this table can be found here

      0. Organization
      Definition

      -


      A 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, payer/insurer, etc.

      ShortA grouping of people or organizations with a common purpose
      Comments

      -

      Control0..*
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: 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 (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())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0)
      org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0)
      2. Organization.implicitRules
      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.

      ShortA set of rules under which this content was created
      Comments

      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.

      Control0..1
      Typeuri
      Is Modifiertrue because 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
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      4. Organization.extension
      Definition

      An Extension


      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.

      ShortExtensionAdditional content defined by implementations
      Comments

      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.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on Organization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 6. Organization.extension:rating
        Slice Namerating
        Definition

        Rating

        ShortNDH Rating
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Rating) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        8. Organization.extension:paymentaccepted
        Slice Namepaymentaccepted
        Definition

        Methods of payment that can be used for a healthcare service

        ShortNDH Payment Accepted
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Payment Accepted) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        10. Organization.extension:fundingSource
        Slice NamefundingSource
        Definition

        The sources of funding for a service or organization

        ShortNDH Funding Source
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Funding Source) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        12. Organization.extension:org-description
        Slice Nameorg-description
        Definition

        An extension to provide a human-readable description of an organization

        ShortOrganization Description
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Org Description) (Extension Type: string)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        14. Organization.extension:digitalcertificate
        Slice Namedigitalcertificate
        Definition

        A digital certificate, used to identify a user or group of users, or for encrypted communications

        ShortDigital Certificate
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Digitalcertificate) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        16. Organization.extension:qualification
        Slice Namequalification
        Definition

        An extension to add qualifications for an organization (e.g. accreditation) or practitionerRole (e.g. registered to prescribe controlled substances).

        ShortQualification
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Qualification) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. Organization.extension:usage-restriction
        Slice Nameusage-restriction
        Definition

        Identifies and conveys information about restrictions on the use or release of exchanged information, e.g. information that can only be shared under particular condition, such as a signed data use agreement between parties

        ShortUsage Restriction
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Usage Restriction) (Extension Type: Reference(NDH Base Restriction)contained)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        20. Organization.extension:insuranceplan
        Slice Nameinsuranceplan
        Definition

        Reference to insuranceplan resource

        ShortInsurance plan(s) offered to the organization's employees
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH InsurancePlan Reference) (Extension Type: Reference(NDH Base InsurancePlan Profile))
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        22. Organization.extension:verification-status
        Slice Nameverification-status
        Definition

        Indicates a resource instance verification status

        ShortNDH Verification Status
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Verification Status) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        24. Organization.extension:logo
        Slice Namelogo
        Definition

        Logo

        ShortNDH Logo
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Logo) (Extension Type: Attachment)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        26. Organization.modifierExtension
        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.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Summaryfalse
        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.

        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        28. Organization.identifier
        Definition

        Identifier for the organization that is used to identify the organization across multiple disparate systems.

        ShortIdentifies this organization across multiple systems
        Comments

        NPI preferred.

        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        This element is affected by the following invariants: org-1
        TypeIdentifier
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        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.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on Organization.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • pattern @ $this
        • 30. Organization.identifier.extension:identifier-status
          Slice Nameidentifier-status
          Definition

          Describes the status of an identifier

          ShortNDH Identifier Status
          Control0..1
          TypeExtension(NDH Identifier Status) (Extension Type: code)
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          32. Organization.identifier.use
          Definition

          The purpose of this identifier.

          Shortusual | official | temp | secondary | old (If known)
          Comments

          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

          Control0..1
          BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
          (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

          Identifies the purpose for this identifier, if known .

          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          34. Organization.identifier.system
          Definition

          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

          ShortThe namespace for the identifier value
          Comments

          Identifier.system is always case sensitive.

          Control0..1
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

          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.

          Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          36. Organization.identifier.value
          Definition

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

          ShortThe value that is unique
          Comments

          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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

          Control0..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Example<br/><b>General</b>:123456
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          38. Organization.identifier.assigner
          Definition

          Organization that issued/manages the identifier.

          ShortOrganization that issued id (may be just text)
          Comments

          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.

          Control0..1
          TypeReference(NDH Base Organization Profile, Organization)
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          40. Organization.identifier:NPI
          Slice NameNPI
          Definition

          Identifier for the organization that is used to identify the organization across multiple disparate systems.

          ShortNational Provider Identifier (NPI)Identifies this organization across multiple systems
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          This element is affected by the following invariants: org-1, us-core-16, us-core-17
          TypeIdentifier
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          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.

          Pattern Value{
            "system" : "http://hl7.org/fhir/sid/us-npi"
          }
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          us-core-16: NPI must be 10 digits (value.matches('^[0-9]{10}$'))
          us-core-17: NPI check digit must be valid (Luhn algorithm check) ((((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))
          42. Organization.identifier:CLIA
          Slice NameCLIA
          Definition

          Identifier for the organization that is used to identify the organization across multiple disparate systems.

          ShortClinical Laboratory Improvement Amendments (CLIA) Number for laboratoriesIdentifies this organization across multiple systems
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          This element is affected by the following invariants: org-1, us-core-18
          TypeIdentifier
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          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.

          Pattern Value{
            "system" : "urn:oid:2.16.840.1.113883.4.7"
          }
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          us-core-18: CLIA number must be 10 digits with a letter "D" in third position (value.matches('^[0-9]{2}D[0-9]{7}$'))
          44. Organization.identifier:NAIC
          Slice NameNAIC
          Definition

          Identifier for the organization that is used to identify the organization across multiple disparate systems.

          ShortNAIC CodeIdentifies this organization across multiple systems
          Comments

          NAIC Company code (sometimes called "NAIC Number" or "cocode") for payers.

          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          This element is affected by the following invariants: org-1, us-core-19
          TypeIdentifier
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          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.

          Pattern Value{
            "system" : "urn:oid:2.16.840.1.113883.6.300"
          }
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          us-core-19: NAIC must be 5 digits (value.matches('^[0-9]{5}$'))
          46. Organization.identifier:TID
          Slice NameTID
          Definition

          Identifier for the organization that is used to identify the organization across multiple disparate systems.

          ShortTax IdentifierIdentifies this organization across multiple systems
          Comments

          NPI preferred.

          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..1*
          This element is affected by the following invariants: org-1
          TypeIdentifier
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          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.

          Pattern Value{
            "system" : "http://hl7.org.fhir/sid/us-ssn"
          }
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          48. Organization.active
          Definition

          Whether the organization's record is still in active use.

          ShortWhether the organization's record is still in active use
          Comments

          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.

          This element is labeled as a modifier because it may be used to mark that the resource was created in error.

          Control10..1
          Typeboolean
          Is Modifiertrue because 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
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          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.

          Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
          Pattern Valuetrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          50. Organization.type
          Definition

          The kind(s) of organization that this is.

          ShortKind of organization
          Comments

          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.

          Control10..*
          BindingUnless not suitable, these codes SHALL be taken from For example codes, see Organization Type Value Sethttp://hl7.org/fhir/ValueSet/organization-type
          (extensible to http://hl7.org/fhir/us/ndh/ValueSet/OrgTypeVS)
          TypeCodeableConcept
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Requirements

          Need to be able to track the kind of organization that this is - different organization types have different uses.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          52. Organization.name
          Definition

          A name associated with the organization.

          ShortName used for the organization
          Comments

          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.

          Control10..1
          This element is affected by the following invariants: org-1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

          Need to use the name as the label of the organization.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          54. Organization.alias
          Definition

          A list of alternate names that the organization is known as, or was known as in the past.

          ShortA list of alternate names that the organization is known as, or was known as in the past
          Comments

          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.

          Control0..*
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summaryfalse
          Requirements

          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.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          56. Organization.alias.extension
          Definition

          An Extension


          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.

          ShortExtensionAdditional content defined by implementations
          Comments

          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.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Organization.alias.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 58. Organization.alias.extension:org-alias-type
            Slice Nameorg-alias-type
            Definition

            Type of organization alias (legal alternative, historical)

            ShortOrganization Alias Type
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(NDH Organization Alias Type) (Extension Type: CodeableConcept)
            Is Modifierfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            60. Organization.alias.extension:org-alias-period
            Slice Nameorg-alias-period
            Definition

            The period of time the organization alias was actively used

            ShortOrganization Alias Period
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(NDH Organization Alias Period) (Extension Type: Period)
            Is Modifierfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            62. Organization.telecom
            Definition

            A contact detail for the organization.

            ShortA contact detail for the organization
            Comments

            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.

            Control0..*
            This element is affected by the following invariants: org-3
            TypeContactPoint
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Requirements

            Human contact for the organization.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
            org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
            64. Organization.telecom.extension:contactpoint-availabletime
            Slice Namecontactpoint-availabletime
            Definition

            An extension representing the days and times a contact point is available

            ShortNDH Contactpoint Availabletime
            Control0..*
            TypeExtension(NDH Contactpoint Availabletime) (Complex Extension)
            Is Modifierfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            66. Organization.telecom.extension:via-intermediary
            Slice Namevia-intermediary
            Definition

            A reference to an alternative point of contact (NdhPractitionerRole, NdhOrganization, NdhOrganizationAffiliation, or NdhLocation) for this organization

            ShortVia Intermediary
            Control0..1
            TypeExtension(NDH Via Intermediary) (Extension Type: Reference(NDH Base PractitionerRole, NDH Base OrganizationAffiliation Profile, NDH Base Location Profile, NDH Base Organization Profile))
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            68. Organization.telecom.extension:language-speak
            Slice Namelanguage-speak
            Definition

            Language Speak

            ShortLanguage Speak
            Control0..*
            TypeExtension(NDH Language Speak) (Extension Type: code)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            70. Organization.telecom.system
            Definition

            Telecommunications form for contact point - what communications system is required to make use of the contact.

            Shortphone | fax | email | pager | url | sms | other
            Control0..1
            This element is affected by the following invariants: cpt-2
            BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
            (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

            Telecommunications form for contact point.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            72. Organization.telecom.value
            Definition

            The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

            ShortThe actual contact point details
            Comments

            Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Requirements

            Need to support legacy numbers that are not in a tightly controlled format.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            74. Organization.telecom.use
            Definition

            Identifies the purpose for the contact point.

            Shorthome | work | temp | old | mobile - purpose of this contact point
            Comments

            Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

            Control0..1
            BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
            (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

            Use of contact point.

            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            76. Organization.address
            Definition

            An address for the organization.

            ShortAn address for the organization
            Comments

            Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

            Control0..*
            This element is affected by the following invariants: org-2
            TypeAddress
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Requirements

            May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
            org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
            78. Organization.address.extension:geolocation
            Slice Namegeolocation
            Definition

            The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

            ShortThe absolute geographic location
            Comments

            The extension can be further extended to include unique geolocation identifiers, confidence, altitude, etc.

            Control0..1
            TypeExtension(Geolocation) (Complex Extension)
            Is Modifierfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            80. Organization.address.use
            Definition

            The purpose of this address.

            Shorthome | work | temp | old | billing - purpose of this address
            Comments

            Applications can assume that an address is current unless it explicitly says that it is temporary or old.

            Control0..1
            BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
            (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

            The use of an address.

            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Allows an appropriate address to be chosen from a list of many.

            Example<br/><b>General</b>:home
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            82. Organization.address.line
            Definition

            This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

            ShortStreet name, number, direction & P.O. Box etc.
            Control0..4*
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Example<br/><b>General</b>:137 Nowhere Street
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            84. Organization.address.city
            Definition

            The name of the city, town, suburb, village or other community or delivery center.

            ShortName of city, town etc.
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Alternate NamesMunicpality
            Example<br/><b>General</b>:Erewhon
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            86. Organization.address.state
            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).

            ShortSub-unit of country (abbreviations ok)
            Control0..1
            BindingUnless not suitable, these codes SHALL be taken from For codes, see USPS Two Letter Alphabetic Codes
            (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state)

            Two letter USPS alphabetic codes.

            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Alternate NamesProvince, Territory
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            88. Organization.address.postalCode
            Definition

            A postal code designating a region defined by the postal service.

            ShortUS Zip CodesPostal code for area
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Alternate NamesZip
            Example<br/><b>General</b>:9132
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            90. Organization.address.country
            Definition

            Country - a nation as commonly understood or generally accepted.

            ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
            Comments

            ISO 3166 3 letter codes can be used in place of a human readable country name.

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            92. Organization.partOf
            Definition

            The organization of which this organization forms a part.

            ShortThe organization of which this organization forms a part
            Control0..1
            TypeReference(NDH Base Organization Profile, Organization)
            Is Modifierfalse
            Summarytrue
            Requirements

            Need to be able to track the hierarchy of organizations within an organization.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            94. Organization.endpoint
            Definition

            Technical endpoints providing access to services operated for the organization.

            ShortTechnical endpoints providing access to services operated for the organization
            Control0..*
            TypeReference(NDH Base Endpoint Profile, Endpoint)
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            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.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

            Guidance on how to interpret the contents of this table can be found here

            0. Organization
            Definition

            -

            ShortA grouping of people or organizations with a common purpose
            Comments

            -

            Control0..*
            Is Modifierfalse
            Must Supportfalse
            Summaryfalse
            Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
            dom-3: 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 (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())
            dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
            dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
            dom-6: A resource should have narrative for robust management (text.`div`.exists())
            org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0)
            2. Organization.id
            Definition

            The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

            ShortLogical id of this artifact
            Comments

            The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

            Control0..1
            Typeid
            Is Modifierfalse
            Summarytrue
            4. Organization.meta
            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.

            ShortMetadata about the resource
            Control0..1
            TypeMeta
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            6. Organization.meta.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            8. Organization.meta.extension
            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.

            ShortAdditional content defined by implementations
            Comments

            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.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on Organization.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 10. Organization.meta.versionId
              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.

              ShortVersion specific identifier
              Comments

              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.

              Control0..1
              Typeid
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              12. Organization.meta.lastUpdated
              Definition

              When the resource last changed - e.g. when the version changed.

              ShortWhen the resource version last changed
              Comments

              This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

              Control1..1
              Typeinstant
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              14. Organization.meta.source
              Definition

              A uri that identifies the source system of the resource. This provides a minimal amount of Provenance 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.

              ShortIdentifies where the resource comes from
              Comments

              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.

              This 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.

              Control0..1
              Typeuri
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              16. Organization.meta.profile
              Definition

              A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

              ShortProfiles this resource claims to conform to
              Comments

              It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

              Control0..*
              Typecanonical(StructureDefinition)
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              18. Organization.meta.security
              Definition

              Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

              ShortSecurity Labels applied to this resource
              Comments

              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.

              Control0..*
              BindingUnless not suitable, these codes SHALL be taken from All Security Labels
              (extensible to http://hl7.org/fhir/ValueSet/security-labels)

              Security Labels from the Healthcare Privacy and Security Classification System.

              TypeCoding
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              20. Organization.meta.tag
              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.

              ShortTags applied to this resource
              Comments

              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.

              Control0..*
              BindingFor example codes, see CommonTags
              (example to http://hl7.org/fhir/ValueSet/common-tags)

              Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

              TypeCoding
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              22. Organization.implicitRules
              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.

              ShortA set of rules under which this content was created
              Comments

              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.

              Control0..1
              Typeuri
              Is Modifiertrue because 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
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              24. Organization.language
              Definition

              The base language in which the resource is written.

              ShortLanguage of the resource content
              Comments

              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).

              Control0..1
              BindingThe codes SHOULD be taken from CommonLanguages
              (preferred to http://hl7.org/fhir/ValueSet/languages)

              A human language.

              Additional BindingsPurpose
              AllLanguagesMax Binding
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              26. Organization.text
              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.

              ShortText summary of the resource, for human interpretation
              Comments

              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.

              Control0..1
              TypeNarrative
              Is Modifierfalse
              Summaryfalse
              Alternate Namesnarrative, html, xhtml, display
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              28. Organization.contained
              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.

              ShortContained, inline Resources
              Comments

              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.

              Control0..*
              TypeResource
              Is Modifierfalse
              Summaryfalse
              Alternate Namesinline resources, anonymous resources, contained resources
              30. Organization.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Organization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 32. Organization.extension:rating
                Slice Namerating
                Definition

                Rating

                ShortNDH Rating
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(NDH Rating) (Complex Extension)
                Is Modifierfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                34. Organization.extension:paymentaccepted
                Slice Namepaymentaccepted
                Definition

                Methods of payment that can be used for a healthcare service

                ShortNDH Payment Accepted
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(NDH Payment Accepted) (Extension Type: CodeableConcept)
                Is Modifierfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                36. Organization.extension:fundingSource
                Slice NamefundingSource
                Definition

                The sources of funding for a service or organization

                ShortNDH Funding Source
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(NDH Funding Source) (Complex Extension)
                Is Modifierfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                38. Organization.extension:org-description
                Slice Nameorg-description
                Definition

                An extension to provide a human-readable description of an organization

                ShortOrganization Description
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(NDH Org Description) (Extension Type: string)
                Is Modifierfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                40. Organization.extension:digitalcertificate
                Slice Namedigitalcertificate
                Definition

                A digital certificate, used to identify a user or group of users, or for encrypted communications

                ShortDigital Certificate
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(NDH Digitalcertificate) (Complex Extension)
                Is Modifierfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                42. Organization.extension:qualification
                Slice Namequalification
                Definition

                An extension to add qualifications for an organization (e.g. accreditation) or practitionerRole (e.g. registered to prescribe controlled substances).

                ShortQualification
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(NDH Qualification) (Complex Extension)
                Is Modifierfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                44. Organization.extension:usage-restriction
                Slice Nameusage-restriction
                Definition

                Identifies and conveys information about restrictions on the use or release of exchanged information, e.g. information that can only be shared under particular condition, such as a signed data use agreement between parties

                ShortUsage Restriction
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(NDH Usage Restriction) (Extension Type: Reference(NDH Base Restriction)contained)
                Is Modifierfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                46. Organization.extension:insuranceplan
                Slice Nameinsuranceplan
                Definition

                Reference to insuranceplan resource

                ShortInsurance plan(s) offered to the organization's employees
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(NDH InsurancePlan Reference) (Extension Type: Reference(NDH Base InsurancePlan Profile))
                Is Modifierfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                48. Organization.extension:verification-status
                Slice Nameverification-status
                Definition

                Indicates a resource instance verification status

                ShortNDH Verification Status
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(NDH Verification Status) (Extension Type: CodeableConcept)
                Is Modifierfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                50. Organization.extension:logo
                Slice Namelogo
                Definition

                Logo

                ShortNDH Logo
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(NDH Logo) (Extension Type: Attachment)
                Is Modifierfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                52. Organization.modifierExtension
                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.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored
                Comments

                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.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                Summaryfalse
                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.

                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                54. Organization.identifier
                Definition

                Identifier for the organization that is used to identify the organization across multiple disparate systems.

                ShortIdentifies this organization across multiple systems
                Comments

                NPI preferred.

                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..*
                This element is affected by the following invariants: org-1
                TypeIdentifier
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                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.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on Organization.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • pattern @ $this
                • 56. Organization.identifier.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  58. Organization.identifier.extension
                  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.

                  ShortAdditional content defined by implementations
                  Comments

                  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.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on Organization.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 60. Organization.identifier.extension:identifier-status
                    Slice Nameidentifier-status
                    Definition

                    Describes the status of an identifier

                    ShortNDH Identifier Status
                    Control0..1
                    TypeExtension(NDH Identifier Status) (Extension Type: code)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    62. Organization.identifier.use
                    Definition

                    The purpose of this identifier.

                    Shortusual | official | temp | secondary | old (If known)
                    Comments

                    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                    Control0..1
                    BindingThe codes SHALL be taken from IdentifierUse
                    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                    Identifies the purpose for this identifier, if known .

                    Typecode
                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    64. Organization.identifier.type
                    Definition

                    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                    ShortDescription of identifier
                    Comments

                    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.

                    Control0..1
                    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                    (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows users to make use of identifiers when the identifier system is not known.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    66. Organization.identifier.system
                    Definition

                    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                    ShortThe namespace for the identifier value
                    Comments

                    Identifier.system is always case sensitive.

                    Control0..1
                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    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.

                    Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    68. Organization.identifier.value
                    Definition

                    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                    ShortThe value that is unique
                    Comments

                    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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    Example<br/><b>General</b>:123456
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    70. Organization.identifier.period
                    Definition

                    Time period during which identifier is/was valid for use.

                    ShortTime period when id is/was valid for use
                    Control0..1
                    TypePeriod
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    72. Organization.identifier.assigner
                    Definition

                    Organization that issued/manages the identifier.

                    ShortOrganization that issued id (may be just text)
                    Comments

                    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.

                    Control0..1
                    TypeReference(NDH Base Organization Profile)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    74. Organization.identifier:NPI
                    Slice NameNPI
                    Definition

                    Identifier for the organization that is used to identify the organization across multiple disparate systems.

                    ShortNational Provider Identifier (NPI)
                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..*
                    This element is affected by the following invariants: org-1, us-core-16, us-core-17
                    TypeIdentifier
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    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.

                    Pattern Value{
                      "system" : "http://hl7.org/fhir/sid/us-npi"
                    }
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    us-core-16: NPI must be 10 digits (value.matches('^[0-9]{10}$'))
                    us-core-17: NPI check digit must be valid (Luhn algorithm check) ((((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))
                    76. Organization.identifier:CLIA
                    Slice NameCLIA
                    Definition

                    Identifier for the organization that is used to identify the organization across multiple disparate systems.

                    ShortClinical Laboratory Improvement Amendments (CLIA) Number for laboratories
                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..*
                    This element is affected by the following invariants: org-1, us-core-18
                    TypeIdentifier
                    Is Modifierfalse
                    Must Supportfalse
                    Summarytrue
                    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.

                    Pattern Value{
                      "system" : "urn:oid:2.16.840.1.113883.4.7"
                    }
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    us-core-18: CLIA number must be 10 digits with a letter "D" in third position (value.matches('^[0-9]{2}D[0-9]{7}$'))
                    78. Organization.identifier:NAIC
                    Slice NameNAIC
                    Definition

                    Identifier for the organization that is used to identify the organization across multiple disparate systems.

                    ShortNAIC Code
                    Comments

                    NAIC Company code (sometimes called "NAIC Number" or "cocode") for payers.

                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..*
                    This element is affected by the following invariants: org-1, us-core-19
                    TypeIdentifier
                    Is Modifierfalse
                    Must Supportfalse
                    Summarytrue
                    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.

                    Pattern Value{
                      "system" : "urn:oid:2.16.840.1.113883.6.300"
                    }
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    us-core-19: NAIC must be 5 digits (value.matches('^[0-9]{5}$'))
                    80. Organization.identifier:TID
                    Slice NameTID
                    Definition

                    Identifier for the organization that is used to identify the organization across multiple disparate systems.

                    ShortTax Identifier
                    Comments

                    NPI preferred.

                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..1
                    This element is affected by the following invariants: org-1
                    TypeIdentifier
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    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.

                    Pattern Value{
                      "system" : "http://hl7.org.fhir/sid/us-ssn"
                    }
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    82. Organization.active
                    Definition

                    Whether the organization's record is still in active use.

                    ShortWhether the organization's record is still in active use
                    Comments

                    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.

                    This element is labeled as a modifier because it may be used to mark that the resource was created in error.

                    Control1..1
                    Typeboolean
                    Is Modifiertrue because 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
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    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.

                    Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                    Pattern Valuetrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    84. Organization.type
                    Definition

                    The kind(s) of organization that this is.

                    ShortKind of organization
                    Comments

                    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.

                    Control1..*
                    BindingUnless not suitable, these codes SHALL be taken from Organization Type Value Set
                    (extensible to http://hl7.org/fhir/us/ndh/ValueSet/OrgTypeVS)
                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    Need to be able to track the kind of organization that this is - different organization types have different uses.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    86. Organization.name
                    Definition

                    A name associated with the organization.

                    ShortName used for the organization
                    Comments

                    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.

                    Control1..1
                    This element is affected by the following invariants: org-1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    Need to use the name as the label of the organization.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    88. Organization.alias
                    Definition

                    A list of alternate names that the organization is known as, or was known as in the past.

                    ShortA list of alternate names that the organization is known as, or was known as in the past
                    Comments

                    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.

                    Control0..*
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summaryfalse
                    Requirements

                    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.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    90. Organization.alias.id
                    Definition

                    unique id for the element within a resource (for internal references)

                    Shortxml:id (or equivalent in JSON)
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    92. Organization.alias.extension
                    Definition

                    An Extension

                    ShortExtension
                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Organization.alias.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 94. Organization.alias.extension:org-alias-type
                      Slice Nameorg-alias-type
                      Definition

                      Type of organization alias (legal alternative, historical)

                      ShortOrganization Alias Type
                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypeExtension(NDH Organization Alias Type) (Extension Type: CodeableConcept)
                      Is Modifierfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      96. Organization.alias.extension:org-alias-period
                      Slice Nameorg-alias-period
                      Definition

                      The period of time the organization alias was actively used

                      ShortOrganization Alias Period
                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypeExtension(NDH Organization Alias Period) (Extension Type: Period)
                      Is Modifierfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      98. Organization.alias.value
                      Definition

                      The actual value

                      ShortPrimitive value for string
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      Max Length:1048576
                      100. Organization.telecom
                      Definition

                      A contact detail for the organization.

                      ShortA contact detail for the organization
                      Comments

                      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.

                      Control0..*
                      This element is affected by the following invariants: org-3
                      TypeContactPoint
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Requirements

                      Human contact for the organization.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
                      102. Organization.telecom.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      104. Organization.telecom.extension
                      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.

                      ShortAdditional content defined by implementations
                      Comments

                      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.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      SlicingThis element introduces a set of slices on Organization.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 106. Organization.telecom.extension:contactpoint-availabletime
                        Slice Namecontactpoint-availabletime
                        Definition

                        An extension representing the days and times a contact point is available

                        ShortNDH Contactpoint Availabletime
                        Control0..*
                        TypeExtension(NDH Contactpoint Availabletime) (Complex Extension)
                        Is Modifierfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        108. Organization.telecom.extension:via-intermediary
                        Slice Namevia-intermediary
                        Definition

                        A reference to an alternative point of contact (NdhPractitionerRole, NdhOrganization, NdhOrganizationAffiliation, or NdhLocation) for this organization

                        ShortVia Intermediary
                        Control0..1
                        TypeExtension(NDH Via Intermediary) (Extension Type: Reference(NDH Base PractitionerRole, NDH Base OrganizationAffiliation Profile, NDH Base Location Profile, NDH Base Organization Profile))
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        110. Organization.telecom.extension:language-speak
                        Slice Namelanguage-speak
                        Definition

                        Language Speak

                        ShortLanguage Speak
                        Control0..*
                        TypeExtension(NDH Language Speak) (Extension Type: code)
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        112. Organization.telecom.system
                        Definition

                        Telecommunications form for contact point - what communications system is required to make use of the contact.

                        Shortphone | fax | email | pager | url | sms | other
                        Control0..1
                        This element is affected by the following invariants: cpt-2
                        BindingThe codes SHALL be taken from ContactPointSystem
                        (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                        Telecommunications form for contact point.

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        114. Organization.telecom.value
                        Definition

                        The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                        ShortThe actual contact point details
                        Comments

                        Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Need to support legacy numbers that are not in a tightly controlled format.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        116. Organization.telecom.use
                        Definition

                        Identifies the purpose for the contact point.

                        Shorthome | work | temp | old | mobile - purpose of this contact point
                        Comments

                        Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                        Control0..1
                        BindingThe codes SHALL be taken from ContactPointUse
                        (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                        Use of contact point.

                        Typecode
                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        118. Organization.telecom.rank
                        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.

                        ShortSpecify preferred order of use (1 = highest)
                        Comments

                        Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                        Control0..1
                        TypepositiveInt
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        120. Organization.telecom.period
                        Definition

                        Time period when the contact point was/is in use.

                        ShortTime period when the contact point was/is in use
                        Control0..1
                        TypePeriod
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        122. Organization.address
                        Definition

                        An address for the organization.

                        ShortAn address for the organization
                        Comments

                        Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

                        Control0..*
                        This element is affected by the following invariants: org-2
                        TypeAddress
                        Is Modifierfalse
                        Must Supporttrue
                        Summaryfalse
                        Requirements

                        May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
                        124. Organization.address.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        126. Organization.address.extension
                        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.

                        ShortAdditional content defined by implementations
                        Comments

                        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.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on Organization.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 128. Organization.address.extension:geolocation
                          Slice Namegeolocation
                          Definition

                          The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

                          ShortThe absolute geographic location
                          Comments

                          The extension can be further extended to include unique geolocation identifiers, confidence, altitude, etc.

                          Control0..1
                          TypeExtension(Geolocation) (Complex Extension)
                          Is Modifierfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          130. Organization.address.use
                          Definition

                          The purpose of this address.

                          Shorthome | work | temp | old | billing - purpose of this address
                          Comments

                          Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                          Control0..1
                          BindingThe codes SHALL be taken from AddressUse
                          (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

                          The use of an address.

                          Typecode
                          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Allows an appropriate address to be chosen from a list of many.

                          Example<br/><b>General</b>:home
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          132. Organization.address.type
                          Definition

                          Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

                          Shortpostal | physical | both
                          Comments

                          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 resource).

                          Control0..1
                          BindingThe codes SHALL be taken from AddressType
                          (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

                          The type of an address (physical / postal).

                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Example<br/><b>General</b>:both
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          134. Organization.address.text
                          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.

                          ShortText representation of the address
                          Comments

                          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.

                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          A renderable, unencoded form.

                          Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          136. Organization.address.line
                          Definition

                          This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                          ShortStreet name, number, direction & P.O. Box etc.
                          Control0..4
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summarytrue
                          Example<br/><b>General</b>:137 Nowhere Street
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          138. Organization.address.city
                          Definition

                          The name of the city, town, suburb, village or other community or delivery center.

                          ShortName of city, town etc.
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summarytrue
                          Alternate NamesMunicpality
                          Example<br/><b>General</b>:Erewhon
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          140. Organization.address.district
                          Definition

                          The name of the administrative area (county).

                          ShortDistrict name (aka county)
                          Comments

                          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.

                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Alternate NamesCounty
                          Example<br/><b>General</b>:Madison
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          142. Organization.address.state
                          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).

                          ShortSub-unit of country (abbreviations ok)
                          Control0..1
                          BindingUnless not suitable, these codes SHALL be taken from USPS Two Letter Alphabetic Codes
                          (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state)

                          Two letter USPS alphabetic codes.

                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summarytrue
                          Alternate NamesProvince, Territory
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          144. Organization.address.postalCode
                          Definition

                          A postal code designating a region defined by the postal service.

                          ShortUS Zip Codes
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summarytrue
                          Alternate NamesZip
                          Example<br/><b>General</b>:9132
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          146. Organization.address.country
                          Definition

                          Country - a nation as commonly understood or generally accepted.

                          ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
                          Comments

                          ISO 3166 3 letter codes can be used in place of a human readable country name.

                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          148. Organization.address.period
                          Definition

                          Time period when address was/is in use.

                          ShortTime period when address was/is in use
                          Control0..1
                          TypePeriod
                          Is Modifierfalse
                          Summarytrue
                          Requirements

                          Allows addresses to be placed in historical context.

                          Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          150. Organization.partOf
                          Definition

                          The organization of which this organization forms a part.

                          ShortThe organization of which this organization forms a part
                          Control0..1
                          TypeReference(NDH Base Organization Profile)
                          Is Modifierfalse
                          Summarytrue
                          Requirements

                          Need to be able to track the hierarchy of organizations within an organization.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          152. Organization.contact
                          Definition

                          Contact for the organization for a certain purpose.

                          ShortContact for the organization for a certain purpose
                          Comments

                          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.

                          Control0..*
                          TypeBackboneElement
                          Is Modifierfalse
                          Summaryfalse
                          Requirements

                          Need to keep track of assigned contact points within bigger organization.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          154. Organization.contact.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          156. Organization.contact.extension
                          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.

                          ShortAdditional content defined by implementations
                          Comments

                          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.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          158. Organization.contact.modifierExtension
                          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.

                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                          ShortExtensions that cannot be ignored even if unrecognized
                          Comments

                          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.

                          Control0..*
                          TypeExtension
                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                          Summarytrue
                          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.

                          Alternate Namesextensions, user content, modifiers
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          160. Organization.contact.purpose
                          Definition

                          Indicates a purpose for which the contact can be reached.

                          ShortThe type of contact
                          Control0..1
                          BindingUnless not suitable, these codes SHALL be taken from ContactEntityType
                          (extensible to http://hl7.org/fhir/ValueSet/contactentity-type)

                          The purpose for which you would contact a contact party.

                          TypeCodeableConcept
                          Is Modifierfalse
                          Summaryfalse
                          Requirements

                          Need to distinguish between multiple contact persons.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          162. Organization.contact.name
                          Definition

                          A name associated with the contact.

                          ShortA name associated with the contact
                          Control0..1
                          TypeHumanName
                          Is Modifierfalse
                          Summaryfalse
                          Requirements

                          Need to be able to track the person by name.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          164. Organization.contact.telecom
                          Definition

                          A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

                          ShortContact details (telephone, email, etc.) for a contact
                          Control0..*
                          TypeContactPoint
                          Is Modifierfalse
                          Summaryfalse
                          Requirements

                          People have (primary) ways to contact them in some way such as phone, email.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          166. Organization.contact.telecom.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          168. Organization.contact.telecom.extension
                          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.

                          ShortAdditional content defined by implementations
                          Comments

                          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.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on Organization.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 170. Organization.contact.telecom.extension:contactpoint-availabletime
                            Slice Namecontactpoint-availabletime
                            Definition

                            An extension representing the days and times a contact point is available

                            ShortNDH Contactpoint Availabletime
                            Control0..*
                            TypeExtension(NDH Contactpoint Availabletime) (Complex Extension)
                            Is Modifierfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            172. Organization.contact.telecom.extension:via-intermediary
                            Slice Namevia-intermediary
                            Definition

                            A reference to an alternative point of contact (NdhPractitionerRole, NdhOrganization, NdhOrganizationAffiliation, or NdhLocation) for this organization

                            ShortVia Intermediary
                            Control0..1
                            TypeExtension(NDH Via Intermediary) (Extension Type: Reference(NDH Base PractitionerRole, NDH Base OrganizationAffiliation Profile, NDH Base Location Profile, NDH Base Organization Profile))
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            174. Organization.contact.telecom.system
                            Definition

                            Telecommunications form for contact point - what communications system is required to make use of the contact.

                            Shortphone | fax | email | pager | url | sms | other
                            Control0..1
                            This element is affected by the following invariants: cpt-2
                            BindingThe codes SHALL be taken from ContactPointSystem
                            (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                            Telecommunications form for contact point.

                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            176. Organization.contact.telecom.value
                            Definition

                            The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                            ShortThe actual contact point details
                            Comments

                            Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Need to support legacy numbers that are not in a tightly controlled format.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            178. Organization.contact.telecom.use
                            Definition

                            Identifies the purpose for the contact point.

                            Shorthome | work | temp | old | mobile - purpose of this contact point
                            Comments

                            Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                            Control0..1
                            BindingThe codes SHALL be taken from ContactPointUse
                            (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                            Use of contact point.

                            Typecode
                            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            180. Organization.contact.telecom.rank
                            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.

                            ShortSpecify preferred order of use (1 = highest)
                            Comments

                            Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                            Control0..1
                            TypepositiveInt
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            182. Organization.contact.telecom.period
                            Definition

                            Time period when the contact point was/is in use.

                            ShortTime period when the contact point was/is in use
                            Control0..1
                            TypePeriod
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            184. Organization.contact.address
                            Definition

                            Visiting or postal addresses for the contact.

                            ShortVisiting or postal addresses for the contact
                            Control0..1
                            TypeAddress
                            Is Modifierfalse
                            Summaryfalse
                            Requirements

                            May need to keep track of a contact party's address for contacting, billing or reporting requirements.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            186. Organization.endpoint
                            Definition

                            Technical endpoints providing access to services operated for the organization.

                            ShortTechnical endpoints providing access to services operated for the organization
                            Control0..*
                            TypeReference(NDH Base Endpoint Profile)
                            Is Modifierfalse
                            Must Supporttrue
                            Summaryfalse
                            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.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))