Pharmaceutical Quality (Industry), published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/uv-dx-pq/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/pharm-quality/StructureDefinition/Organization-drug-pq | Version: 1.0.0 | |||
Active as of 2024-05-08 | Computable Name: OrganizationDrugPq | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.41.42.33 |
This Organization profile represents information about a pharmaceutical company or site that performed drug testing or manufacturing.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | Organization | |||
identifier | 1..* | Identifier | Identifies this organization across multiple systems | |
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
active | 0..1 | boolean | Whether this organization's record is in active use | |
type | S | 1..* | CodeableConcept | Kind of organization Binding: Pharmaceutical Organization Type (preferred) |
name | 0..1 | string | Organization's legal name | |
alias | 0..* | string | A list of alternate names for this organization | |
description | 0..1 | markdown | Additional details about the Organization | |
contact | ||||
Slices for telecom | 0..* | ContactPoint | Contact details (e.g.phone/fax/url) Slice: Unordered, Open by value:system | |
telecom:phone | 0..* | ContactPoint | Phone | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone | |
telecom:email | 0..* | ContactPoint | email | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |
telecom:url | 0..* | ContactPoint | Web Site | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: url | |
address | ||||
use | 0..1 | code | home | work | temp | old | billing Required Pattern: work | |
type | 0..1 | code | postal|physical|both | |
text | 0..1 | string | Text representation of the address. | |
line | 1..* | string | Street name, number, direction & P.O. Box etc. | |
city | 1..1 | string | Name of city, town etc. | |
country | 1..1 | string | Country (e.g. may be ISO 3166 2 or 3 letter code) Binding: ISO Country two letter codes (preferred) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.type | preferred | PharmaceuticalOrganizationType (a valid code from Pharmaceutical Organization Type Codes)http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-pharmaceutical-organization-type from this IG | |
Organization.contact.address.country | preferred | VsCountryPQhttp://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-country-pq from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣC | 1..* | Identifier | Identifies this organization across multiple systems |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether this organization's record is in active use |
type | SΣ | 1..* | CodeableConcept | Kind of organization Binding: Pharmaceutical Organization Type (preferred) |
name | ΣC | 0..1 | string | Organization's legal name |
alias | 0..* | string | A list of alternate names for this organization | |
description | Σ | 0..1 | markdown | Additional details about the Organization |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Organization.type | preferred | PharmaceuticalOrganizationType (a valid code from Pharmaceutical Organization Type Codes)http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-pharmaceutical-organization-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | ΣC | 1..* | Identifier | Identifies this organization across multiple systems | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether this organization's record is in active use | ||||
type | SΣ | 1..* | CodeableConcept | Kind of organization Binding: Pharmaceutical Organization Type (preferred) | ||||
name | ΣC | 0..1 | string | Organization's legal name | ||||
alias | 0..* | string | A list of alternate names for this organization | |||||
description | Σ | 0..1 | markdown | Additional details about the Organization | ||||
contact | C | 0..* | ExtendedContactDetail | Official contact details for the Organization org-3: The telecom of an organization can never be of use 'home' org-4: The address of an organization can never be of use 'home' | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
purpose | Σ | 0..1 | CodeableConcept | The type of contact Binding: Contact entity type (preferred): The purpose for which an extended contact detail should be used. | ||||
name | Σ | 0..* | HumanName | Name of an individual to contact | ||||
Slices for telecom | Σ | 0..* | ContactPoint | Contact details (e.g.phone/fax/url) Slice: Unordered, Open by value:system | ||||
telecom:phone | Σ | 0..* | ContactPoint | Phone | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone | ||||
value | ΣC | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:email | Σ | 0..* | ContactPoint | email | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
value | ΣC | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:url | Σ | 0..* | ContactPoint | Web Site | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: url | ||||
value | ΣC | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
address | Σ | 0..1 | Address | Address for the contact | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing Binding: AddressUse (required): The use of an address (home / work / etc.). Required Pattern: work | ||||
type | Σ | 0..1 | code | postal|physical|both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address. Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | Σ | 1..* | 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 | ||||
city | Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 1..1 | string | Country (e.g. may be ISO 3166 2 or 3 letter code) Binding: ISO Country two letter codes (preferred) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
organization | Σ | 0..1 | Reference(Organization) | This contact detail is handled/monitored by a specific organization | ||||
period | Σ | 0..1 | Period | Period that this contact was valid for usage | ||||
partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
qualification | 0..* | BackboneElement | Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | 0..* | Identifier | An identifier for this qualification for the organization | |||||
code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: (unbound) (example): Specific qualification the organization has to provide a service. | |||||
period | 0..1 | Period | Period during which the qualification is valid | |||||
issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Organization.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Organization.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Organization.type | preferred | PharmaceuticalOrganizationType (a valid code from Pharmaceutical Organization Type Codes)http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-pharmaceutical-organization-type from this IG | |
Organization.contact.purpose | preferred | ContactEntityTypehttp://terminology.hl7.org/ValueSet/contactentity-type | |
Organization.contact.telecom:phone.system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Organization.contact.telecom:phone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Organization.contact.telecom:email.system | required | Pattern: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Organization.contact.telecom:email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Organization.contact.telecom:url.system | required | Pattern: urlhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Organization.contact.telecom:url.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Organization.contact.address.use | required | Pattern: workhttp://hl7.org/fhir/ValueSet/address-use|5.0.0 from the FHIR Standard | |
Organization.contact.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|5.0.0 from the FHIR Standard | |
Organization.contact.address.country | preferred | VsCountryPQhttp://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-country-pq from this IG | |
Organization.qualification.code | example |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-3 | error | Organization.contact | The telecom of an organization can never be of use 'home' : telecom.where(use = 'home').empty() | |
org-4 | error | Organization.contact | The address of an organization can never be of use 'home' : address.where(use = 'home').empty() |
This structure is derived from Organization
Summary
Mandatory: 4 elements(6 nested mandatory elements)
Must-Support: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Organization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | Organization | |||
identifier | 1..* | Identifier | Identifies this organization across multiple systems | |
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
active | 0..1 | boolean | Whether this organization's record is in active use | |
type | S | 1..* | CodeableConcept | Kind of organization Binding: Pharmaceutical Organization Type (preferred) |
name | 0..1 | string | Organization's legal name | |
alias | 0..* | string | A list of alternate names for this organization | |
description | 0..1 | markdown | Additional details about the Organization | |
contact | ||||
Slices for telecom | 0..* | ContactPoint | Contact details (e.g.phone/fax/url) Slice: Unordered, Open by value:system | |
telecom:phone | 0..* | ContactPoint | Phone | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone | |
telecom:email | 0..* | ContactPoint | email | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |
telecom:url | 0..* | ContactPoint | Web Site | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: url | |
address | ||||
use | 0..1 | code | home | work | temp | old | billing Required Pattern: work | |
type | 0..1 | code | postal|physical|both | |
text | 0..1 | string | Text representation of the address. | |
line | 1..* | string | Street name, number, direction & P.O. Box etc. | |
city | 1..1 | string | Name of city, town etc. | |
country | 1..1 | string | Country (e.g. may be ISO 3166 2 or 3 letter code) Binding: ISO Country two letter codes (preferred) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.type | preferred | PharmaceuticalOrganizationType (a valid code from Pharmaceutical Organization Type Codes)http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-pharmaceutical-organization-type from this IG | |
Organization.contact.address.country | preferred | VsCountryPQhttp://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-country-pq from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣC | 1..* | Identifier | Identifies this organization across multiple systems |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether this organization's record is in active use |
type | SΣ | 1..* | CodeableConcept | Kind of organization Binding: Pharmaceutical Organization Type (preferred) |
name | ΣC | 0..1 | string | Organization's legal name |
alias | 0..* | string | A list of alternate names for this organization | |
description | Σ | 0..1 | markdown | Additional details about the Organization |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Organization.type | preferred | PharmaceuticalOrganizationType (a valid code from Pharmaceutical Organization Type Codes)http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-pharmaceutical-organization-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | Organization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | ΣC | 1..* | Identifier | Identifies this organization across multiple systems | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether this organization's record is in active use | ||||
type | SΣ | 1..* | CodeableConcept | Kind of organization Binding: Pharmaceutical Organization Type (preferred) | ||||
name | ΣC | 0..1 | string | Organization's legal name | ||||
alias | 0..* | string | A list of alternate names for this organization | |||||
description | Σ | 0..1 | markdown | Additional details about the Organization | ||||
contact | C | 0..* | ExtendedContactDetail | Official contact details for the Organization org-3: The telecom of an organization can never be of use 'home' org-4: The address of an organization can never be of use 'home' | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
purpose | Σ | 0..1 | CodeableConcept | The type of contact Binding: Contact entity type (preferred): The purpose for which an extended contact detail should be used. | ||||
name | Σ | 0..* | HumanName | Name of an individual to contact | ||||
Slices for telecom | Σ | 0..* | ContactPoint | Contact details (e.g.phone/fax/url) Slice: Unordered, Open by value:system | ||||
telecom:phone | Σ | 0..* | ContactPoint | Phone | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone | ||||
value | ΣC | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:email | Σ | 0..* | ContactPoint | email | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
value | ΣC | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:url | Σ | 0..* | ContactPoint | Web Site | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: url | ||||
value | ΣC | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
address | Σ | 0..1 | Address | Address for the contact | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing Binding: AddressUse (required): The use of an address (home / work / etc.). Required Pattern: work | ||||
type | Σ | 0..1 | code | postal|physical|both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address. Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | Σ | 1..* | 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 | ||||
city | Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 1..1 | string | Country (e.g. may be ISO 3166 2 or 3 letter code) Binding: ISO Country two letter codes (preferred) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
organization | Σ | 0..1 | Reference(Organization) | This contact detail is handled/monitored by a specific organization | ||||
period | Σ | 0..1 | Period | Period that this contact was valid for usage | ||||
partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
qualification | 0..* | BackboneElement | Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
identifier | 0..* | Identifier | An identifier for this qualification for the organization | |||||
code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: (unbound) (example): Specific qualification the organization has to provide a service. | |||||
period | 0..1 | Period | Period during which the qualification is valid | |||||
issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Organization.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Organization.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Organization.type | preferred | PharmaceuticalOrganizationType (a valid code from Pharmaceutical Organization Type Codes)http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-pharmaceutical-organization-type from this IG | |
Organization.contact.purpose | preferred | ContactEntityTypehttp://terminology.hl7.org/ValueSet/contactentity-type | |
Organization.contact.telecom:phone.system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Organization.contact.telecom:phone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Organization.contact.telecom:email.system | required | Pattern: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Organization.contact.telecom:email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Organization.contact.telecom:url.system | required | Pattern: urlhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Organization.contact.telecom:url.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Organization.contact.address.use | required | Pattern: workhttp://hl7.org/fhir/ValueSet/address-use|5.0.0 from the FHIR Standard | |
Organization.contact.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|5.0.0 from the FHIR Standard | |
Organization.contact.address.country | preferred | VsCountryPQhttp://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-country-pq from this IG | |
Organization.qualification.code | example |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-3 | error | Organization.contact | The telecom of an organization can never be of use 'home' : telecom.where(use = 'home').empty() | |
org-4 | error | Organization.contact | The address of an organization can never be of use 'home' : address.where(use = 'home').empty() |
This structure is derived from Organization
Summary
Mandatory: 4 elements(6 nested mandatory elements)
Must-Support: 1 element
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron