Patient Cost Transparency Implementation Guide
0.1.0 - STU 1 Ballot

This page is part of the Da Vinci Patient Cost Transparency Implementation Guide (v0.1.0: STU 1 Draft) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: PCT Organization

Defining URL:http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-organization
Version:0.1.0
Name:PCTOrganization
Title:PCT Organization
Status:Active as of 12/4/21 9:54 PM
Definition:

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

Publisher:HL7 International - Financial Management Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-organization

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from HRexOrganization

Summary

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

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Organization.identifier is sliced based on the value of pattern:$this
  • The element Organization.contact is sliced based on the value of pattern:purpose

This structure is derived from HRexOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*HRexOrganizationA grouping of people or organizations with a common purpose
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... providerTaxonomy S0..1CodeableConceptProvider taxonomy codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers
URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/providerTaxonomy
Binding: US Core Provider Role (NUCC) (extensible)
... Slices for identifier 1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI 0..1IdentifierNational Provider Identifier (NPI)
Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
....... display1..1stringRepresentation defined by the system
Fixed Value: National provider identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... identifier:ETIN S0..1IdentifierElectronic Transmitter Identification Number.
Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgIdentifierTypeCS
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ETIN
....... display1..1stringRepresentation defined by the system
Fixed Value: Electronic Transmitter Identification Number
.... identifier:TAX S0..1IdentifierTax ID Number
Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: TAX
....... display1..1stringRepresentation defined by the system
Fixed Value: Tax ID number
... address
.... countrySubdivisionCode S0..1CodingCountry Subdivision Code - from Part 2 of ISO 3166
URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/countrySubdivisionCode
Binding: HL7 Value Set for State/Province (example)
.... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-2 (required)
... Slices for contact S0..*BackboneElementContact for the organization for a certain purpose
Slice: Unordered, Open by pattern:purpose
.... contact:All Slices Content/Rules for all slices
..... purpose 0..1CodeableConceptThe type of contact
Binding: PCT Organization Contact Purpose Value Set - locally defined for testing purpose; an external FHIR value set will be created through the HL7 Terminology (THO) process to replace this value set (extensible)
.... contact:gfeServiceHotline S0..1BackboneElementContact for the organization for a certain purpose
..... purpose S1..1CodeableConceptThe type of contact
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgContactPurposeType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: GFERELATED
....... display1..1stringRepresentation defined by the system
Fixed Value: GFE-related
..... name S1..1HumanNameA name associated with the contact
..... telecom S1..*ContactPointContact details (telephone, email, etc.) for a contact
... endpoint S0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*HRexOrganizationA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... providerTaxonomy S0..1CodeableConceptProvider taxonomy codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers
URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/providerTaxonomy
Binding: US Core Provider Role (NUCC) (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣI1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣI0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
....... display1..1stringRepresentation defined by the system
Fixed Value: National provider identifier
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CLIA SΣI0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:tin SΣI0..1IdentifierIdentifies this organization across multiple systems

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:ccn SΣI0..1IdentifierIdentifies this organization across multiple systems

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://todo/medicare-certification-number
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:ETIN SΣI0..1IdentifierElectronic Transmitter Identification Number.

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgIdentifierTypeCS
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ETIN
....... display1..1stringRepresentation defined by the system
Fixed Value: Electronic Transmitter Identification Number
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:TAX SΣI0..1IdentifierTax ID Number

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: TAX
....... display1..1stringRepresentation defined by the system
Fixed Value: Tax ID number
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type SΣ1..*CodeableConceptKind of organization
Binding: PCT Organization Type Value Set - locally defined for testing purpose; an external FHIR value set will be created through the HL7 Terminology (THO) process to replace this value set (extensible)
... name SΣI1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI0..*ContactPointA contact detail for the organization
... address SI0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... countrySubdivisionCode S0..1CodingCountry Subdivision Code - from Part 2 of ISO 3166
URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/countrySubdivisionCode
Binding: HL7 Value Set for State/Province (example)
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..4stringStreet 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
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-2 (required)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... Slices for contact S0..*BackboneElementContact for the organization for a certain purpose
Slice: Unordered, Open by pattern:purpose
.... contact:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... purpose 0..1CodeableConceptThe type of contact
Binding: PCT Organization Contact Purpose Value Set - locally defined for testing purpose; an external FHIR value set will be created through the HL7 Terminology (THO) process to replace this value set (extensible)
..... name 0..1HumanNameA name associated with the contact
..... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
..... address 0..1AddressVisiting or postal addresses for the contact
.... contact:gfeServiceHotline S0..1BackboneElementContact for the organization for a certain purpose
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... purpose S1..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgContactPurposeType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: GFERELATED
....... display1..1stringRepresentation defined by the system
Fixed Value: GFE-related
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... name S1..1HumanNameA name associated with the contact
..... telecom S1..*ContactPointContact details (telephone, email, etc.) for a contact
..... address 0..1AddressVisiting or postal addresses for the contact
... endpoint S0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*HRexOrganizationA grouping of people or organizations with a common purpose
... providerTaxonomy 0..1CodeableConceptProvider taxonomy codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers
URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/providerTaxonomy
Binding: US Core Provider Role (NUCC) (extensible)
... Slices for identifier ΣI1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI ΣI0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
....... display1..1stringRepresentation defined by the system
Fixed Value: National provider identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... identifier:CLIA ΣI0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
.... identifier:tin ΣI0..1IdentifierIdentifies this organization across multiple systems

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
.... identifier:ccn ΣI0..1IdentifierIdentifies this organization across multiple systems

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://todo/medicare-certification-number
.... identifier:ETIN ΣI0..1IdentifierElectronic Transmitter Identification Number.

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgIdentifierTypeCS
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ETIN
....... display1..1stringRepresentation defined by the system
Fixed Value: Electronic Transmitter Identification Number
.... identifier:TAX ΣI0..1IdentifierTax ID Number

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: TAX
....... display1..1stringRepresentation defined by the system
Fixed Value: Tax ID number
... active ?!Σ1..1booleanWhether the organization's record is still in active use
... name ΣI1..1stringName used for the organization
... telecom I0..*ContactPointA contact detail for the organization
... address I0..*AddressAn address for the organization
.... countrySubdivisionCode 0..1CodingCountry Subdivision Code - from Part 2 of ISO 3166
URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/countrySubdivisionCode
Binding: HL7 Value Set for State/Province (example)
.... line Σ0..4stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
.... city Σ0..1stringName of city, town etc.
.... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode Σ0..1stringUS Zip Codes
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-2 (required)
... Slices for contact 0..*BackboneElementContact for the organization for a certain purpose
Slice: Unordered, Open by pattern:purpose
.... contact:gfeServiceHotline 0..1BackboneElementContact for the organization for a certain purpose
..... purpose 1..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgContactPurposeType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: GFERELATED
....... display1..1stringRepresentation defined by the system
Fixed Value: GFE-related
..... name 1..1HumanNameA name associated with the contact
..... telecom 1..*ContactPointContact details (telephone, email, etc.) for a contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

This structure is derived from HRexOrganization

Summary

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

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Organization.identifier is sliced based on the value of pattern:$this
  • The element Organization.contact is sliced based on the value of pattern:purpose

Differential View

This structure is derived from HRexOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*HRexOrganizationA grouping of people or organizations with a common purpose
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... providerTaxonomy S0..1CodeableConceptProvider taxonomy codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers
URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/providerTaxonomy
Binding: US Core Provider Role (NUCC) (extensible)
... Slices for identifier 1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI 0..1IdentifierNational Provider Identifier (NPI)
Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
....... display1..1stringRepresentation defined by the system
Fixed Value: National provider identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... identifier:ETIN S0..1IdentifierElectronic Transmitter Identification Number.
Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgIdentifierTypeCS
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ETIN
....... display1..1stringRepresentation defined by the system
Fixed Value: Electronic Transmitter Identification Number
.... identifier:TAX S0..1IdentifierTax ID Number
Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: TAX
....... display1..1stringRepresentation defined by the system
Fixed Value: Tax ID number
... address
.... countrySubdivisionCode S0..1CodingCountry Subdivision Code - from Part 2 of ISO 3166
URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/countrySubdivisionCode
Binding: HL7 Value Set for State/Province (example)
.... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-2 (required)
... Slices for contact S0..*BackboneElementContact for the organization for a certain purpose
Slice: Unordered, Open by pattern:purpose
.... contact:All Slices Content/Rules for all slices
..... purpose 0..1CodeableConceptThe type of contact
Binding: PCT Organization Contact Purpose Value Set - locally defined for testing purpose; an external FHIR value set will be created through the HL7 Terminology (THO) process to replace this value set (extensible)
.... contact:gfeServiceHotline S0..1BackboneElementContact for the organization for a certain purpose
..... purpose S1..1CodeableConceptThe type of contact
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgContactPurposeType
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: GFERELATED
....... display1..1stringRepresentation defined by the system
Fixed Value: GFE-related
..... name S1..1HumanNameA name associated with the contact
..... telecom S1..*ContactPointContact details (telephone, email, etc.) for a contact
... endpoint S0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*HRexOrganizationA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... providerTaxonomy S0..1CodeableConceptProvider taxonomy codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers
URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/providerTaxonomy
Binding: US Core Provider Role (NUCC) (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣI1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣI0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
....... display1..1stringRepresentation defined by the system
Fixed Value: National provider identifier
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CLIA SΣI0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:tin SΣI0..1IdentifierIdentifies this organization across multiple systems

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:ccn SΣI0..1IdentifierIdentifies this organization across multiple systems

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://todo/medicare-certification-number
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:ETIN SΣI0..1IdentifierElectronic Transmitter Identification Number.

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgIdentifierTypeCS
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ETIN
....... display1..1stringRepresentation defined by the system
Fixed Value: Electronic Transmitter Identification Number
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:TAX SΣI0..1IdentifierTax ID Number

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: TAX
....... display1..1stringRepresentation defined by the system
Fixed Value: Tax ID number
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system0..1uriThe namespace for the identifier value
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type SΣ1..*CodeableConceptKind of organization
Binding: PCT Organization Type Value Set - locally defined for testing purpose; an external FHIR value set will be created through the HL7 Terminology (THO) process to replace this value set (extensible)
... name SΣI1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI0..*ContactPointA contact detail for the organization
... address SI0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... countrySubdivisionCode S0..1CodingCountry Subdivision Code - from Part 2 of ISO 3166
URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/countrySubdivisionCode
Binding: HL7 Value Set for State/Province (example)
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..4stringStreet 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
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-2 (required)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... Slices for contact S0..*BackboneElementContact for the organization for a certain purpose
Slice: Unordered, Open by pattern:purpose
.... contact:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... purpose 0..1CodeableConceptThe type of contact
Binding: PCT Organization Contact Purpose Value Set - locally defined for testing purpose; an external FHIR value set will be created through the HL7 Terminology (THO) process to replace this value set (extensible)
..... name 0..1HumanNameA name associated with the contact
..... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
..... address 0..1AddressVisiting or postal addresses for the contact
.... contact:gfeServiceHotline S0..1BackboneElementContact for the organization for a certain purpose
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... purpose S1..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTOrgContactPurposeType
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: GFERELATED
....... display1..1stringRepresentation defined by the system
Fixed Value: GFE-related
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... name S1..1HumanNameA name associated with the contact
..... telecom S1..*ContactPointContact details (telephone, email, etc.) for a contact
..... address 0..1AddressVisiting or postal addresses for the contact
... endpoint S0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Organization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Organization.typeextensiblePCTOrganizationTypeVS
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes
Organization.address.countryrequiredIso3166-1-2
Organization.contact.purposeextensiblePCTOrgContactPurposeTypeVS
Organization.contact:gfeServiceHotline.purposeextensiblePattern: GFERELATED("GFE-related")

Constraints

IdPathDetailsRequirements
dom-2OrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3OrganizationIf 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-4OrganizationIf 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-5OrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6OrganizationA resource should have narrative for robust management
: text.`div`.exists()
org-1OrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
ele-1Organization.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.extension:providerTaxonomyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.extension:providerTaxonomyMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:NPIAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:CLIAAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:tinAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:ccnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:ETINAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:TAXAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.aliasAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-3Organization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1Organization.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-2Organization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1Organization.address.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.address.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.address.extension:countrySubdivisionCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.address.extension:countrySubdivisionCodeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.address.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.lineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.contact.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.contact.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.contact.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.contact.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact:gfeServiceHotlineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact:gfeServiceHotline.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.contact:gfeServiceHotline.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.contact:gfeServiceHotline.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.contact:gfeServiceHotline.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.contact:gfeServiceHotline.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact:gfeServiceHotline.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact:gfeServiceHotline.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact:gfeServiceHotline.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())