Regulatory Workflows and Interactions - pharma
0.1.0 - ci-build
Regulatory Workflows and Interactions - pharma
0.1.0 - ci-build
Regulatory Workflows and Interactions - pharma, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/APIX---API-Exchange-for-Medicinal-Products/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/apix/StructureDefinition/apix-organization | Version: 0.1.0 | ||||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: APIXOrganization | |||
Organization profile for APIX regulatory workflows, derived from and compatible with ePI requirements.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1 |
  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 the organization's record is still in active use | |
| type |
0..* | CodeableConcept | Kind of organization Binding: https://www.fda.gov/industry/structured-product-labeling-resources/business-operation (example): Used to categorize the organization. | |
| name |
C | 1..1 | string | Name used for the organization |
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
| description |
0..1 | markdown | Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name | |
| contact |
C | 1..* | ExtendedContactDetail | Official contact details for the Organization Constraints: org-3, org-4 |
 Slices for telecom |
1..* | ContactPoint | Contact details (e.g.phone/fax/url) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  telecom:phone |
0..1 | ContactPoint | Contact details (e.g.phone/fax/url) | |
  system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone (extensions allowed) |
| value |
C | 1..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. | |
 telecom:email |
1..1 | ContactPoint | Contact details (e.g.phone/fax/url) | |
 system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email (extensions allowed) |
| value |
C | 1..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. | |
 address |
0..1 | Address | Address for the contact | |
| use |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home | |
| text |
0..1 | string | Full text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |
| line |
0..* | 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 |
0..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 (state, region, province) | |
| postalCode |
0..1 | string | Postal code for area Example General: 9132 | |
| country |
0..1 | string | Country (e.g., can be ISO 3166 2 letter code) | |
 endpoint |
1..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Organization.type | Base | example | https://www.fda.gov/industry/structured-product-labeling-resources/business-operation | Not State | Unknown |
| Organization.contact.telecom:phone.system | Base | required | ContactPointSystem | 📍5.0.0 | FHIR Std. |
| Organization.contact.telecom:phone.use | Base | required | ContactPointUse | 📍5.0.0 | FHIR Std. |
| Organization.contact.telecom:email.system | Base | required | ContactPointSystem | 📍5.0.0 | FHIR Std. |
| Organization.contact.telecom:email.use | Base | required | ContactPointUse | 📍5.0.0 | FHIR Std. |
| Organization.contact.address.use | Base | required | AddressUse | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organization |
0..* | Organization | A grouping of people or organizations with a common purpose | |
 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 | |
| type |
0..* | CodeableConcept | Kind of organization Binding: https://www.fda.gov/industry/structured-product-labeling-resources/business-operation (example): Used to categorize the organization. | |
| name |
1..1 | string | Name used for the organization | |
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
| description |
0..1 | markdown | Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name | |
| contact |
1..* | ExtendedContactDetail | Official contact details for the Organization | |
| Slices for telecom |
1..* | ContactPoint | Contact details (e.g.phone/fax/url) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| telecom:phone |
0..1 | ContactPoint | Contact details (e.g.phone/fax/url) | |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone (extensions allowed) | |
| value |
1..1 | string | The actual contact point details | |
| telecom:email |
1..1 | ContactPoint | Contact details (e.g.phone/fax/url) | |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email (extensions allowed) | |
| value |
1..1 | string | The actual contact point details | |
| address |
0..1 | Address | Address for the contact | |
| text |
0..1 | string | Full text representation of the address | |
| line |
0..* | string | Street name, number, direction & P.O. Box etc. | |
| city |
0..1 | string | Name of city, town etc. | |
| district |
0..1 | string | District name (aka county) | |
| state |
0..1 | string | Sub-unit of country (state, region, province) | |
| postalCode |
0..1 | string | Postal code for area | |
| country |
0..1 | string | Country (e.g., can be ISO 3166 2 letter code) | |
| endpoint |
1..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.type | Base | example | https://www.fda.gov/industry/structured-product-labeling-resources/business-operation | Not State | Unknown |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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 the organization's record is still in active use | |||||
| type |
0..* | CodeableConcept | Kind of organization Binding: https://www.fda.gov/industry/structured-product-labeling-resources/business-operation (example): Used to categorize the organization. | |||||
| name |
C | 1..1 | string | Name used for the organization | ||||
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
| description |
0..1 | markdown | Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name | |||||
| contact |
C | 1..* | ExtendedContactDetail | Official contact details for the Organization Constraints: org-3, org-4 | ||||
| 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 |
1..* | ContactPoint | Contact details (e.g.phone/fax/url) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| telecom:phone |
0..1 | ContactPoint | Contact details (e.g.phone/fax/url) | |||||
| 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 (extensions allowed) | ||||
| value |
C | 1..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 |
1..1 | ContactPoint | Contact details (e.g.phone/fax/url) | |||||
| 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 (extensions allowed) | ||||
| value |
C | 1..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 - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home | |||||
| type |
0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||
| text |
0..1 | string | Full text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||
| line |
0..* | 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 |
0..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 (state, region, province) | |||||
| postalCode |
0..1 | string | Postal code for area Example General: 9132 | |||||
| country |
0..1 | string | Country (e.g., can be ISO 3166 2 letter code) | |||||
| 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 |
1..* | 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 Description: (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 | Status | Usage | ValueSet | Version | Source |
| Organization.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Organization.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Organization.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Organization.type | Base | example | https://www.fda.gov/industry/structured-product-labeling-resources/business-operation | Not State | Unknown |
| Organization.contact.purpose | Base | preferred | Contact entity type | 📦2.0.0 | THO v7.4 |
| Organization.contact.telecom:phone.system | Base | required | ContactPointSystem | 📍5.0.0 | FHIR Std. |
| Organization.contact.telecom:phone.use | Base | required | ContactPointUse | 📍5.0.0 | FHIR Std. |
| Organization.contact.telecom:email.system | Base | required | ContactPointSystem | 📍5.0.0 | FHIR Std. |
| Organization.contact.telecom:email.use | Base | required | ContactPointUse | 📍5.0.0 | FHIR Std. |
| Organization.contact.address.use | Base | required | AddressUse | 📍5.0.0 | FHIR Std. |
| Organization.contact.address.type | Base | required | AddressType | 📍5.0.0 | FHIR Std. |
| Organization.qualification.code | Base | example | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1 |
| 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 the organization's record is still in active use | |
| type |
0..* | CodeableConcept | Kind of organization Binding: https://www.fda.gov/industry/structured-product-labeling-resources/business-operation (example): Used to categorize the organization. | |
| name |
C | 1..1 | string | Name used for the organization |
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
| description |
0..1 | markdown | Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name | |
| contact |
C | 1..* | ExtendedContactDetail | Official contact details for the Organization Constraints: org-3, org-4 |
| Slices for telecom |
1..* | ContactPoint | Contact details (e.g.phone/fax/url) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| telecom:phone |
0..1 | ContactPoint | Contact details (e.g.phone/fax/url) | |
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone (extensions allowed) |
| value |
C | 1..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. | |
| telecom:email |
1..1 | ContactPoint | Contact details (e.g.phone/fax/url) | |
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email (extensions allowed) |
| value |
C | 1..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. | |
| address |
0..1 | Address | Address for the contact | |
| use |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home | |
| text |
0..1 | string | Full text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |
| line |
0..* | 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 |
0..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 (state, region, province) | |
| postalCode |
0..1 | string | Postal code for area Example General: 9132 | |
| country |
0..1 | string | Country (e.g., can be ISO 3166 2 letter code) | |
| endpoint |
1..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Organization.type | Base | example | https://www.fda.gov/industry/structured-product-labeling-resources/business-operation | Not State | Unknown |
| Organization.contact.telecom:phone.system | Base | required | ContactPointSystem | 📍5.0.0 | FHIR Std. |
| Organization.contact.telecom:phone.use | Base | required | ContactPointUse | 📍5.0.0 | FHIR Std. |
| Organization.contact.telecom:email.system | Base | required | ContactPointSystem | 📍5.0.0 | FHIR Std. |
| Organization.contact.telecom:email.use | Base | required | ContactPointUse | 📍5.0.0 | FHIR Std. |
| Organization.contact.address.use | Base | required | AddressUse | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
Differential View
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organization |
0..* | Organization | A grouping of people or organizations with a common purpose | |
| 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 | |
| type |
0..* | CodeableConcept | Kind of organization Binding: https://www.fda.gov/industry/structured-product-labeling-resources/business-operation (example): Used to categorize the organization. | |
| name |
1..1 | string | Name used for the organization | |
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
| description |
0..1 | markdown | Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name | |
| contact |
1..* | ExtendedContactDetail | Official contact details for the Organization | |
| Slices for telecom |
1..* | ContactPoint | Contact details (e.g.phone/fax/url) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| telecom:phone |
0..1 | ContactPoint | Contact details (e.g.phone/fax/url) | |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone (extensions allowed) | |
| value |
1..1 | string | The actual contact point details | |
| telecom:email |
1..1 | ContactPoint | Contact details (e.g.phone/fax/url) | |
| system |
1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email (extensions allowed) | |
| value |
1..1 | string | The actual contact point details | |
| address |
0..1 | Address | Address for the contact | |
| text |
0..1 | string | Full text representation of the address | |
| line |
0..* | string | Street name, number, direction & P.O. Box etc. | |
| city |
0..1 | string | Name of city, town etc. | |
| district |
0..1 | string | District name (aka county) | |
| state |
0..1 | string | Sub-unit of country (state, region, province) | |
| postalCode |
0..1 | string | Postal code for area | |
| country |
0..1 | string | Country (e.g., can be ISO 3166 2 letter code) | |
| endpoint |
1..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.type | Base | example | https://www.fda.gov/industry/structured-product-labeling-resources/business-operation | Not State | Unknown |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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 the organization's record is still in active use | |||||
| type |
0..* | CodeableConcept | Kind of organization Binding: https://www.fda.gov/industry/structured-product-labeling-resources/business-operation (example): Used to categorize the organization. | |||||
| name |
C | 1..1 | string | Name used for the organization | ||||
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
| description |
0..1 | markdown | Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name | |||||
| contact |
C | 1..* | ExtendedContactDetail | Official contact details for the Organization Constraints: org-3, org-4 | ||||
| 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 |
1..* | ContactPoint | Contact details (e.g.phone/fax/url) Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| telecom:phone |
0..1 | ContactPoint | Contact details (e.g.phone/fax/url) | |||||
| 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 (extensions allowed) | ||||
| value |
C | 1..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 |
1..1 | ContactPoint | Contact details (e.g.phone/fax/url) | |||||
| 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 (extensions allowed) | ||||
| value |
C | 1..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 - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home | |||||
| type |
0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||
| text |
0..1 | string | Full text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||
| line |
0..* | 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 |
0..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 (state, region, province) | |||||
| postalCode |
0..1 | string | Postal code for area Example General: 9132 | |||||
| country |
0..1 | string | Country (e.g., can be ISO 3166 2 letter code) | |||||
| 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 |
1..* | 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 Description: (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 | Status | Usage | ValueSet | Version | Source |
| Organization.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Organization.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Organization.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Organization.type | Base | example | https://www.fda.gov/industry/structured-product-labeling-resources/business-operation | Not State | Unknown |
| Organization.contact.purpose | Base | preferred | Contact entity type | 📦2.0.0 | THO v7.4 |
| Organization.contact.telecom:phone.system | Base | required | ContactPointSystem | 📍5.0.0 | FHIR Std. |
| Organization.contact.telecom:phone.use | Base | required | ContactPointUse | 📍5.0.0 | FHIR Std. |
| Organization.contact.telecom:email.system | Base | required | ContactPointSystem | 📍5.0.0 | FHIR Std. |
| Organization.contact.telecom:email.use | Base | required | ContactPointUse | 📍5.0.0 | FHIR Std. |
| Organization.contact.address.use | Base | required | AddressUse | 📍5.0.0 | FHIR Std. |
| Organization.contact.address.type | Base | required | AddressType | 📍5.0.0 | FHIR Std. |
| Organization.qualification.code | Base | example | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| 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
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 International / Biomedical Research and Regulation.
Package hl7.fhir.uv.apix#0.1.0 based on FHIR 5.0.0.
Generated
2026-10-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change