Patient Cost Transparency Implementation Guide
2.0.2 - STU 2 United States of America flag

Patient Cost Transparency Implementation Guide, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.0.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pct/ and changes regularly. See the Directory of published versions

Resource Profile: PCT Organization

Official URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-organization Version: 2.0.2
Standards status: Trial-use Maturity Level: 2 Computable Name: PCTOrganization
Other Identifiers: OID:2.16.840.1.113883.4.642.40.4.42.19

The PCT Organization profile builds upon the US Core Organization profile. It is used to convey a payer, provider, payee, or service facility organization.

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 1.1.0:

  • New Content

    • Formal Views of Profile Content

    Description Differentials, Snapshots, and other representations.

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Organization C 0..* HRexOrganization A grouping of people or organizations with a common purpose
    This profile also complies with the profile US Core Organization Profile (3.1.1)
    Constraints: org-1
    Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Organization.Slices for identifier This element must be supported. This element is included in summaries. C 1..* Identifier Identifies this organization across multiple systems
    Slice: Unordered, Open by pattern:$this

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Organization.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..1 Identifier National Provider Identifier (NPI)
    Constraints: us-core-16, us-core-17

    Required Pattern: 
    {
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
    Organization.Slices for identifier.identifier:CLIA This element is included in summaries. C 0..1 Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
    Constraints: us-core-18

    Required Pattern: 
    {
  "system" : "urn:oid:2.16.840.1.113883.4.7"
}
    Organization.Slices for identifier.identifier:NAIC This element is included in summaries. C 0..* Identifier NAIC Code
    Constraints: us-core-19

    Required Pattern: 
    {
  "system" : "urn:oid:2.16.840.1.113883.6.300"
}
    Organization.Slices for identifier.identifier:tin This element must be supported. This element is included in summaries. C 0..1 Identifier Tax ID Number

    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "TAX"
      }
    ]
  },
  "system" : "urn:oid:2.16.840.1.113883.4.4"
}
    Organization.Slices for identifier.identifier:ETIN This element must be supported. This element is included in summaries. C 0..1 Identifier Electronic Transmitter Identification Number.

    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "ETIN"
      }
    ]
  }
}
    Organization.Slices for identifier.identifier:payerid This element must be supported. This element is included in summaries. C 0..1 Identifier Identifies this organization across multiple systems

    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "PAYERID"
      }
    ]
  }
}
    Organization.Slices for identifier.identifier:payerid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Organization.Slices for identifier.identifier:payerid.value This element is included in summaries. 1..1 string The value that is unique
    Example General: 123456
    Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
    Organization.type This element is included in summaries. 1..* CodeableConcept Kind of organization
    Binding: PCT Organization Type Value Set (extensible)
    Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
    Organization.telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
    Constraints: org-3
    Organization.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.
    Organization.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
    Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
    Binding: ContactPointUse (required): Use of contact point.
    Organization.address This element must be supported. C 0..* Address An address for the organization
    Constraints: org-2
    Organization.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.
    Example General: home
    Organization.address.line This element must be supported. This element is included in summaries. 0..4 string Street name, number, direction & P.O. Box etc.
    This repeating element order: The order in which lines should appear in an address label
    Example General: 137 Nowhere Street
    Example General: 49 MEADOW ST
    Organization.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
    Example General: Erewhon
    Example General: EVERYTOWN
    Organization.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
    Binding: UspsTwoLetterAlphabeticCodes (7.0.0) (extensible): Two letter USPS alphabetic codes.
    Example General: OK
    Organization.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
    Example General: 9132
    Example General: 74047
    Organization.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
    Binding: Iso3166-1-2 (required)
    Organization.Slices for contact This element must be supported. 0..* BackboneElement Contact for the organization for a certain purpose
    Slice: Unordered, Open by value:purpose

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Organization.Slices for contact.contact:All Slices Content/Rules for all slices
    Organization.Slices for contact.contact:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Organization.Slices for contact.contact:All Slices.purpose 0..1 CodeableConcept The type of contact
    Binding: PCT Organization Contact Purpose Value Set (extensible)
    Organization.Slices for contact.contact:gfeServiceHotline This element must be supported. 0..1 BackboneElement Contact for the organization for a certain purpose
    Organization.Slices for contact.contact:gfeServiceHotline.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Organization.Slices for contact.contact:gfeServiceHotline.purpose 1..1 CodeableConcept The type of contact
    Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgContactPurposeType",
      "code" : "GFERELATED"
    }
  ]
}
    Organization.Slices for contact.contact:gfeServiceHotline.name 1..1 HumanName A name associated with the contact
    Organization.Slices for contact.contact:gfeServiceHotline.telecom 1..* ContactPoint Contact details (telephone, email, etc.) for a contact

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Organization.identifier:payerid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Organization.type Base extensible PCT Organization Type Value Set 📦2.0.2 This IG
    Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
    Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
    Organization.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
    Organization.address.​state Base extensible USPS Two Letter Alphabetic Codes 📍7.0.0 US Core v7.0
    Organization.address.​country Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
    Organization.contact.​purpose Base extensible PCT Organization Contact Purpose Value Set 📦2.0.2 This IG
    Organization.contact:gfeServiceHotline.​purpose Base extensible Contact entity type 📦4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    us-core-19 error Organization.identifier:NAIC NAIC must be 5 digits value.matches('^[0-9]{5}$')

    This structure is derived from HRexOrganization

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Organization HRexOrganization This profile also complies with the profile US Core Organization Profile (3.1.1)
    Organization.Slices for identifier Content/Rules for all slices
    Organization.Slices for identifier.identifier:NPI 0..1 Identifier National Provider Identifier (NPI)
    Organization.Slices for identifier.identifier:CLIA 0..1 Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
    Organization.Slices for identifier.identifier:tin 0..1 Identifier Tax ID Number
    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "TAX"
      }
    ]
  },
  "system" : "urn:oid:2.16.840.1.113883.4.4"
}
    Organization.Slices for identifier.identifier:ETIN This element must be supported. 0..1 Identifier Electronic Transmitter Identification Number.
    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "ETIN"
      }
    ]
  }
}
    Organization.Slices for identifier.identifier:payerid This element must be supported. 0..1 Identifier Identifies this organization across multiple systems
    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "PAYERID"
      }
    ]
  }
}
    Organization.Slices for identifier.identifier:payerid.value 1..1 string The value that is unique
    Organization.type 1..* CodeableConcept Kind of organization
    Binding: PCT Organization Type Value Set (extensible)
    Organization.address
    Organization.address.country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
    Binding: Iso3166-1-2 (required)
    Organization.Slices for contact This element must be supported. 0..* BackboneElement Contact for the organization for a certain purpose
    Slice: Unordered, Open by value:purpose
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Organization.Slices for contact.contact:All Slices Content/Rules for all slices
    Organization.Slices for contact.contact:All Slices.purpose 0..1 CodeableConcept The type of contact
    Binding: PCT Organization Contact Purpose Value Set (extensible)
    Organization.Slices for contact.contact:gfeServiceHotline This element must be supported. 0..1 BackboneElement Contact for the organization for a certain purpose
    Organization.Slices for contact.contact:gfeServiceHotline.purpose 1..1 CodeableConcept The type of contact
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgContactPurposeType",
      "code" : "GFERELATED"
    }
  ]
}
    Organization.Slices for contact.contact:gfeServiceHotline.name 1..1 HumanName A name associated with the contact
    Organization.Slices for contact.contact:gfeServiceHotline.telecom 1..* ContactPoint Contact details (telephone, email, etc.) for a contact

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Organization.type Base extensible PCT Organization Type Value Set 📦2.0.2 This IG
    Organization.address.​country Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
    Organization.contact.​purpose Base extensible PCT Organization Contact Purpose Value Set 📦2.0.2 This IG
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Organization C 0..* HRexOrganization A grouping of people or organizations with a common purpose
    This profile also complies with the profile US Core Organization Profile (3.1.1)
    Constraints: org-1
    Organization.id This element is included in summaries. 0..1 id Logical id of this artifact
    Organization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Organization.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Organization.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    Organization.contained 0..* Resource Contained, inline Resources
    Organization.extension 0..* Extension Additional content defined by implementations
    Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Organization.Slices for identifier This element must be supported. This element is included in summaries. C 1..* Identifier Identifies this organization across multiple systems
    Slice: Unordered, Open by pattern:$this

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Organization.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..1 Identifier National Provider Identifier (NPI)
    Constraints: us-core-16, us-core-17

    Required Pattern: 
    {
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
    Organization.Slices for identifier.identifier:CLIA This element is included in summaries. C 0..1 Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
    Constraints: us-core-18

    Required Pattern: 
    {
  "system" : "urn:oid:2.16.840.1.113883.4.7"
}
    Organization.Slices for identifier.identifier:NAIC This element is included in summaries. C 0..* Identifier NAIC Code
    Constraints: us-core-19

    Required Pattern: 
    {
  "system" : "urn:oid:2.16.840.1.113883.6.300"
}
    Organization.Slices for identifier.identifier:tin This element must be supported. This element is included in summaries. C 0..1 Identifier Tax ID Number

    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "TAX"
      }
    ]
  },
  "system" : "urn:oid:2.16.840.1.113883.4.4"
}
    Organization.Slices for identifier.identifier:ETIN This element must be supported. This element is included in summaries. C 0..1 Identifier Electronic Transmitter Identification Number.

    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "ETIN"
      }
    ]
  }
}
    Organization.Slices for identifier.identifier:payerid This element must be supported. This element is included in summaries. C 0..1 Identifier Identifies this organization across multiple systems

    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "PAYERID"
      }
    ]
  }
}
    Organization.Slices for identifier.identifier:payerid.id 0..1 string Unique id for inter-element referencing
    Organization.Slices for identifier.identifier:payerid.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Organization.Slices for identifier.identifier:payerid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Organization.Slices for identifier.identifier:payerid.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
    Organization.Slices for identifier.identifier:payerid.system This element is included in summaries. 0..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    Organization.Slices for identifier.identifier:payerid.value This element is included in summaries. 1..1 string The value that is unique
    Example General: 123456
    Organization.Slices for identifier.identifier:payerid.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
    Organization.Slices for identifier.identifier:payerid.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
    Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
    Organization.type This element is included in summaries. 1..* CodeableConcept Kind of organization
    Binding: PCT Organization Type Value Set (extensible)
    Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
    Organization.alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
    Organization.telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
    Constraints: org-3
    Organization.telecom.id 0..1 string Unique id for inter-element referencing
    Organization.telecom.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Organization.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.
    Organization.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
    Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
    Binding: ContactPointUse (required): Use of contact point.
    Organization.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
    Organization.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
    Organization.address This element must be supported. C 0..* Address An address for the organization
    Constraints: org-2
    Organization.address.id 0..1 string Unique id for inter-element referencing
    Organization.address.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Organization.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.
    Example General: home
    Organization.address.type This element is included in summaries. 0..1 code postal | physical | both
    Binding: AddressType (required): The type of an address (physical / postal).
    Example General: both
    Organization.address.text This element is included in summaries. 0..1 string Text representation of the address
    Example General: 137 Nowhere Street, Erewhon 9132
    Organization.address.line This element must be supported. This element is included in summaries. 0..4 string Street name, number, direction & P.O. Box etc.
    This repeating element order: The order in which lines should appear in an address label
    Example General: 137 Nowhere Street
    Example General: 49 MEADOW ST
    Organization.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
    Example General: Erewhon
    Example General: EVERYTOWN
    Organization.address.district This element is included in summaries. 0..1 string District name (aka county)
    Example General: Madison
    Organization.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
    Binding: UspsTwoLetterAlphabeticCodes (7.0.0) (extensible): Two letter USPS alphabetic codes.
    Example General: OK
    Organization.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
    Example General: 9132
    Example General: 74047
    Organization.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
    Binding: Iso3166-1-2 (required)
    Organization.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
    Example General: {"start":"2010-03-23","end":"2010-07-01"}
    Organization.partOf This element is included in summaries. 0..1 Reference(Organization) The organization of which this organization forms a part
    Organization.Slices for contact This element must be supported. 0..* BackboneElement Contact for the organization for a certain purpose
    Slice: Unordered, Open by value:purpose

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Organization.Slices for contact.contact:All Slices Content/Rules for all slices
    Organization.Slices for contact.contact:All Slices.id 0..1 string Unique id for inter-element referencing
    Organization.Slices for contact.contact:All Slices.extension 0..* Extension Additional content defined by implementations
    Organization.Slices for contact.contact:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Organization.Slices for contact.contact:All Slices.purpose 0..1 CodeableConcept The type of contact
    Binding: PCT Organization Contact Purpose Value Set (extensible)
    Organization.Slices for contact.contact:All Slices.name 0..1 HumanName A name associated with the contact
    Organization.Slices for contact.contact:All Slices.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
    Organization.Slices for contact.contact:All Slices.address 0..1 Address Visiting or postal addresses for the contact
    Organization.Slices for contact.contact:gfeServiceHotline This element must be supported. 0..1 BackboneElement Contact for the organization for a certain purpose
    Organization.Slices for contact.contact:gfeServiceHotline.id 0..1 string Unique id for inter-element referencing
    Organization.Slices for contact.contact:gfeServiceHotline.extension 0..* Extension Additional content defined by implementations
    Organization.Slices for contact.contact:gfeServiceHotline.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Organization.Slices for contact.contact:gfeServiceHotline.purpose 1..1 CodeableConcept The type of contact
    Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgContactPurposeType",
      "code" : "GFERELATED"
    }
  ]
}
    Organization.Slices for contact.contact:gfeServiceHotline.name 1..1 HumanName A name associated with the contact
    Organization.Slices for contact.contact:gfeServiceHotline.telecom 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
    Organization.Slices for contact.contact:gfeServiceHotline.address 0..1 Address Visiting or postal addresses for the contact
    Organization.endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Organization.language Base preferred Common Languages 📦4.0.1 FHIR Std.
    Organization.identifier:payerid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Organization.identifier:payerid.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
    Organization.type Base extensible PCT Organization Type Value Set 📦2.0.2 This IG
    Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
    Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
    Organization.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
    Organization.address.​type Base required AddressType 📍4.0.1 FHIR Std.
    Organization.address.​state Base extensible USPS Two Letter Alphabetic Codes 📍7.0.0 US Core v7.0
    Organization.address.​country Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
    Organization.contact.​purpose Base extensible PCT Organization Contact Purpose Value Set 📦2.0.2 This IG
    Organization.contact:gfeServiceHotline.​purpose Base extensible Contact entity type 📦4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    us-core-19 error Organization.identifier:NAIC NAIC must be 5 digits value.matches('^[0-9]{5}$')

    This structure is derived from HRexOrganization

    Summary

    Mandatory: 1 element(4 nested mandatory elements)
    Must-Support: 4 elements

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of Organization.contact

    Maturity: 2

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Organization C 0..* HRexOrganization A grouping of people or organizations with a common purpose
    This profile also complies with the profile US Core Organization Profile (3.1.1)
    Constraints: org-1
    Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Organization.Slices for identifier This element must be supported. This element is included in summaries. C 1..* Identifier Identifies this organization across multiple systems
    Slice: Unordered, Open by pattern:$this

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Organization.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..1 Identifier National Provider Identifier (NPI)
    Constraints: us-core-16, us-core-17

    Required Pattern: 
    {
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
    Organization.Slices for identifier.identifier:CLIA This element is included in summaries. C 0..1 Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
    Constraints: us-core-18

    Required Pattern: 
    {
  "system" : "urn:oid:2.16.840.1.113883.4.7"
}
    Organization.Slices for identifier.identifier:NAIC This element is included in summaries. C 0..* Identifier NAIC Code
    Constraints: us-core-19

    Required Pattern: 
    {
  "system" : "urn:oid:2.16.840.1.113883.6.300"
}
    Organization.Slices for identifier.identifier:tin This element must be supported. This element is included in summaries. C 0..1 Identifier Tax ID Number

    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "TAX"
      }
    ]
  },
  "system" : "urn:oid:2.16.840.1.113883.4.4"
}
    Organization.Slices for identifier.identifier:ETIN This element must be supported. This element is included in summaries. C 0..1 Identifier Electronic Transmitter Identification Number.

    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "ETIN"
      }
    ]
  }
}
    Organization.Slices for identifier.identifier:payerid This element must be supported. This element is included in summaries. C 0..1 Identifier Identifies this organization across multiple systems

    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "PAYERID"
      }
    ]
  }
}
    Organization.Slices for identifier.identifier:payerid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Organization.Slices for identifier.identifier:payerid.value This element is included in summaries. 1..1 string The value that is unique
    Example General: 123456
    Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
    Organization.type This element is included in summaries. 1..* CodeableConcept Kind of organization
    Binding: PCT Organization Type Value Set (extensible)
    Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
    Organization.telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
    Constraints: org-3
    Organization.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.
    Organization.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
    Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
    Binding: ContactPointUse (required): Use of contact point.
    Organization.address This element must be supported. C 0..* Address An address for the organization
    Constraints: org-2
    Organization.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.
    Example General: home
    Organization.address.line This element must be supported. This element is included in summaries. 0..4 string Street name, number, direction & P.O. Box etc.
    This repeating element order: The order in which lines should appear in an address label
    Example General: 137 Nowhere Street
    Example General: 49 MEADOW ST
    Organization.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
    Example General: Erewhon
    Example General: EVERYTOWN
    Organization.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
    Binding: UspsTwoLetterAlphabeticCodes (7.0.0) (extensible): Two letter USPS alphabetic codes.
    Example General: OK
    Organization.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
    Example General: 9132
    Example General: 74047
    Organization.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
    Binding: Iso3166-1-2 (required)
    Organization.Slices for contact This element must be supported. 0..* BackboneElement Contact for the organization for a certain purpose
    Slice: Unordered, Open by value:purpose

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Organization.Slices for contact.contact:All Slices Content/Rules for all slices
    Organization.Slices for contact.contact:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Organization.Slices for contact.contact:All Slices.purpose 0..1 CodeableConcept The type of contact
    Binding: PCT Organization Contact Purpose Value Set (extensible)
    Organization.Slices for contact.contact:gfeServiceHotline This element must be supported. 0..1 BackboneElement Contact for the organization for a certain purpose
    Organization.Slices for contact.contact:gfeServiceHotline.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Organization.Slices for contact.contact:gfeServiceHotline.purpose 1..1 CodeableConcept The type of contact
    Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgContactPurposeType",
      "code" : "GFERELATED"
    }
  ]
}
    Organization.Slices for contact.contact:gfeServiceHotline.name 1..1 HumanName A name associated with the contact
    Organization.Slices for contact.contact:gfeServiceHotline.telecom 1..* ContactPoint Contact details (telephone, email, etc.) for a contact

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Organization.identifier:payerid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Organization.type Base extensible PCT Organization Type Value Set 📦2.0.2 This IG
    Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
    Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
    Organization.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
    Organization.address.​state Base extensible USPS Two Letter Alphabetic Codes 📍7.0.0 US Core v7.0
    Organization.address.​country Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
    Organization.contact.​purpose Base extensible PCT Organization Contact Purpose Value Set 📦2.0.2 This IG
    Organization.contact:gfeServiceHotline.​purpose Base extensible Contact entity type 📦4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    us-core-19 error Organization.identifier:NAIC NAIC must be 5 digits value.matches('^[0-9]{5}$')

    Differential View

    This structure is derived from HRexOrganization

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Organization HRexOrganization This profile also complies with the profile US Core Organization Profile (3.1.1)
    Organization.Slices for identifier Content/Rules for all slices
    Organization.Slices for identifier.identifier:NPI 0..1 Identifier National Provider Identifier (NPI)
    Organization.Slices for identifier.identifier:CLIA 0..1 Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
    Organization.Slices for identifier.identifier:tin 0..1 Identifier Tax ID Number
    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "TAX"
      }
    ]
  },
  "system" : "urn:oid:2.16.840.1.113883.4.4"
}
    Organization.Slices for identifier.identifier:ETIN This element must be supported. 0..1 Identifier Electronic Transmitter Identification Number.
    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "ETIN"
      }
    ]
  }
}
    Organization.Slices for identifier.identifier:payerid This element must be supported. 0..1 Identifier Identifies this organization across multiple systems
    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "PAYERID"
      }
    ]
  }
}
    Organization.Slices for identifier.identifier:payerid.value 1..1 string The value that is unique
    Organization.type 1..* CodeableConcept Kind of organization
    Binding: PCT Organization Type Value Set (extensible)
    Organization.address
    Organization.address.country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
    Binding: Iso3166-1-2 (required)
    Organization.Slices for contact This element must be supported. 0..* BackboneElement Contact for the organization for a certain purpose
    Slice: Unordered, Open by value:purpose
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Organization.Slices for contact.contact:All Slices Content/Rules for all slices
    Organization.Slices for contact.contact:All Slices.purpose 0..1 CodeableConcept The type of contact
    Binding: PCT Organization Contact Purpose Value Set (extensible)
    Organization.Slices for contact.contact:gfeServiceHotline This element must be supported. 0..1 BackboneElement Contact for the organization for a certain purpose
    Organization.Slices for contact.contact:gfeServiceHotline.purpose 1..1 CodeableConcept The type of contact
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgContactPurposeType",
      "code" : "GFERELATED"
    }
  ]
}
    Organization.Slices for contact.contact:gfeServiceHotline.name 1..1 HumanName A name associated with the contact
    Organization.Slices for contact.contact:gfeServiceHotline.telecom 1..* ContactPoint Contact details (telephone, email, etc.) for a contact

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Organization.type Base extensible PCT Organization Type Value Set 📦2.0.2 This IG
    Organization.address.​country Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
    Organization.contact.​purpose Base extensible PCT Organization Contact Purpose Value Set 📦2.0.2 This IG

    Snapshot ViewView

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Organization C 0..* HRexOrganization A grouping of people or organizations with a common purpose
    This profile also complies with the profile US Core Organization Profile (3.1.1)
    Constraints: org-1
    Organization.id This element is included in summaries. 0..1 id Logical id of this artifact
    Organization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Organization.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Organization.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    Organization.contained 0..* Resource Contained, inline Resources
    Organization.extension 0..* Extension Additional content defined by implementations
    Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Organization.Slices for identifier This element must be supported. This element is included in summaries. C 1..* Identifier Identifies this organization across multiple systems
    Slice: Unordered, Open by pattern:$this

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Organization.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..1 Identifier National Provider Identifier (NPI)
    Constraints: us-core-16, us-core-17

    Required Pattern: 
    {
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
    Organization.Slices for identifier.identifier:CLIA This element is included in summaries. C 0..1 Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
    Constraints: us-core-18

    Required Pattern: 
    {
  "system" : "urn:oid:2.16.840.1.113883.4.7"
}
    Organization.Slices for identifier.identifier:NAIC This element is included in summaries. C 0..* Identifier NAIC Code
    Constraints: us-core-19

    Required Pattern: 
    {
  "system" : "urn:oid:2.16.840.1.113883.6.300"
}
    Organization.Slices for identifier.identifier:tin This element must be supported. This element is included in summaries. C 0..1 Identifier Tax ID Number

    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "TAX"
      }
    ]
  },
  "system" : "urn:oid:2.16.840.1.113883.4.4"
}
    Organization.Slices for identifier.identifier:ETIN This element must be supported. This element is included in summaries. C 0..1 Identifier Electronic Transmitter Identification Number.

    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "ETIN"
      }
    ]
  }
}
    Organization.Slices for identifier.identifier:payerid This element must be supported. This element is included in summaries. C 0..1 Identifier Identifies this organization across multiple systems

    Required Pattern: 
    {
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "PAYERID"
      }
    ]
  }
}
    Organization.Slices for identifier.identifier:payerid.id 0..1 string Unique id for inter-element referencing
    Organization.Slices for identifier.identifier:payerid.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Organization.Slices for identifier.identifier:payerid.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Organization.Slices for identifier.identifier:payerid.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
    Organization.Slices for identifier.identifier:payerid.system This element is included in summaries. 0..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    Organization.Slices for identifier.identifier:payerid.value This element is included in summaries. 1..1 string The value that is unique
    Example General: 123456
    Organization.Slices for identifier.identifier:payerid.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
    Organization.Slices for identifier.identifier:payerid.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
    Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
    Organization.type This element is included in summaries. 1..* CodeableConcept Kind of organization
    Binding: PCT Organization Type Value Set (extensible)
    Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
    Organization.alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
    Organization.telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
    Constraints: org-3
    Organization.telecom.id 0..1 string Unique id for inter-element referencing
    Organization.telecom.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Organization.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.
    Organization.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
    Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
    Binding: ContactPointUse (required): Use of contact point.
    Organization.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
    Organization.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
    Organization.address This element must be supported. C 0..* Address An address for the organization
    Constraints: org-2
    Organization.address.id 0..1 string Unique id for inter-element referencing
    Organization.address.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Organization.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.
    Example General: home
    Organization.address.type This element is included in summaries. 0..1 code postal | physical | both
    Binding: AddressType (required): The type of an address (physical / postal).
    Example General: both
    Organization.address.text This element is included in summaries. 0..1 string Text representation of the address
    Example General: 137 Nowhere Street, Erewhon 9132
    Organization.address.line This element must be supported. This element is included in summaries. 0..4 string Street name, number, direction & P.O. Box etc.
    This repeating element order: The order in which lines should appear in an address label
    Example General: 137 Nowhere Street
    Example General: 49 MEADOW ST
    Organization.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
    Example General: Erewhon
    Example General: EVERYTOWN
    Organization.address.district This element is included in summaries. 0..1 string District name (aka county)
    Example General: Madison
    Organization.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
    Binding: UspsTwoLetterAlphabeticCodes (7.0.0) (extensible): Two letter USPS alphabetic codes.
    Example General: OK
    Organization.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
    Example General: 9132
    Example General: 74047
    Organization.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
    Binding: Iso3166-1-2 (required)
    Organization.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
    Example General: {"start":"2010-03-23","end":"2010-07-01"}
    Organization.partOf This element is included in summaries. 0..1 Reference(Organization) The organization of which this organization forms a part
    Organization.Slices for contact This element must be supported. 0..* BackboneElement Contact for the organization for a certain purpose
    Slice: Unordered, Open by value:purpose

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Organization.Slices for contact.contact:All Slices Content/Rules for all slices
    Organization.Slices for contact.contact:All Slices.id 0..1 string Unique id for inter-element referencing
    Organization.Slices for contact.contact:All Slices.extension 0..* Extension Additional content defined by implementations
    Organization.Slices for contact.contact:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Organization.Slices for contact.contact:All Slices.purpose 0..1 CodeableConcept The type of contact
    Binding: PCT Organization Contact Purpose Value Set (extensible)
    Organization.Slices for contact.contact:All Slices.name 0..1 HumanName A name associated with the contact
    Organization.Slices for contact.contact:All Slices.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
    Organization.Slices for contact.contact:All Slices.address 0..1 Address Visiting or postal addresses for the contact
    Organization.Slices for contact.contact:gfeServiceHotline This element must be supported. 0..1 BackboneElement Contact for the organization for a certain purpose
    Organization.Slices for contact.contact:gfeServiceHotline.id 0..1 string Unique id for inter-element referencing
    Organization.Slices for contact.contact:gfeServiceHotline.extension 0..* Extension Additional content defined by implementations
    Organization.Slices for contact.contact:gfeServiceHotline.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Organization.Slices for contact.contact:gfeServiceHotline.purpose 1..1 CodeableConcept The type of contact
    Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgContactPurposeType",
      "code" : "GFERELATED"
    }
  ]
}
    Organization.Slices for contact.contact:gfeServiceHotline.name 1..1 HumanName A name associated with the contact
    Organization.Slices for contact.contact:gfeServiceHotline.telecom 1..* ContactPoint Contact details (telephone, email, etc.) for a contact
    Organization.Slices for contact.contact:gfeServiceHotline.address 0..1 Address Visiting or postal addresses for the contact
    Organization.endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Organization.language Base preferred Common Languages 📦4.0.1 FHIR Std.
    Organization.identifier:payerid.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Organization.identifier:payerid.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
    Organization.type Base extensible PCT Organization Type Value Set 📦2.0.2 This IG
    Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
    Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
    Organization.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
    Organization.address.​type Base required AddressType 📍4.0.1 FHIR Std.
    Organization.address.​state Base extensible USPS Two Letter Alphabetic Codes 📍7.0.0 US Core v7.0
    Organization.address.​country Base required Iso 3166 Part 1: 2 Letter Codes 📦4.0.1 FHIR Std.
    Organization.contact.​purpose Base extensible PCT Organization Contact Purpose Value Set 📦2.0.2 This IG
    Organization.contact:gfeServiceHotline.​purpose Base extensible Contact entity type 📦4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    us-core-19 error Organization.identifier:NAIC NAIC must be 5 digits value.matches('^[0-9]{5}$')

    This structure is derived from HRexOrganization

    Summary

    Mandatory: 1 element(4 nested mandatory elements)
    Must-Support: 4 elements

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of Organization.contact

    Maturity: 2

     

    Other representations of profile: CSV, Excel, Schematron