Population ---------- Description ~~~~~~~~~~~ .. toctree:: :maxdepth: 1 description.md Properties ~~~~~~~~~~ .. csv-table:: :header: "Name","Type","","Description" :widths: 15,10,5,100 "DefiningConceptReference",":doc:`/item-types/Concept/index`","0..1","A concept that defines or aids in understanding the content of the population. For example the Population ""Males"" may link to the concept of ""Male""." "UniverseReference",":doc:`/item-types/Universe/index`","0..1","Reference to the Universe that defines the Unit Type and shared characteristics of this Population, such as businesses in the manufacturing industry. The Universe is independent of geographic area and time period; the Population supplies that scope. TypeOfObject should be set to Universe." "UnitTypeReference",":doc:`/item-types/UnitType/index`","0..1","Reference to a unit type being associated with this Population. TypeOfObject should be set to UnitType." "TypeOfUnit",":doc:`/composite-types/CodeValueType/index`","0..1","The entity type associated with this Population. For example, individuals, families or households, groups, institutions/organizations, administrative units, etc. Supports the use of an external controlled vocabulary." "GeographyOfPopulation",":doc:`/composite-types/GeographicCoverageType/index`","0..1","Description of the geographic coverage of the population." "TimePeriodOfPopulation",":doc:`/composite-types/DateType/index`","0..n","Reference to specific time period for the Population. Repeat for non-continuous time periods." "IsInclusive","`boolean `_","0..1","The default value is true. The description statement of a Population is generally stated in inclusive terms such as All persons residing in Europe. Occasionally a Population is defined by what it excludes, i.e., All persons residing in Europe except for those residing on U.S. Military bases. In this case the value would be changed to false." Properties Inherited from Describable ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. csv-table:: :header: "Name","Type","","Description" :widths: 15,10,5,100 "Name","`langString `_","0..n","A name for the item." "Label","`langString `_","0..n","A display label for the item." "Description","`langString `_","0..n","A description of the content and purpose of the item." Properties Inherited from Versionable ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. csv-table:: :header: "Name","Type","","Description" :widths: 15,10,5,100 "URN","`string `_","1..1"," Constraints: pattern=[Uu][Rr][Nn]:[Dd][Dd][Ii]:[a-zA-Z0-9\-]{1,63}(\.[a-zA-Z0-9\-]{1,63})*:[A-Za-z0-9\*@$\-_]+(\.[A-Za-z0-9\*@$\-_]+)?:[0-9]+(\.[0-9]+)*." "Agency","`string `_","1..1"," Constraints: minLength=1; maxLength=253; pattern=[a-zA-Z0-9\-]{1,63}(\.[a-zA-Z0-9\-]{1,63})*." "ID","`string `_","1..1"," Constraints: pattern=[A-Za-z0-9\*@$\-_]+(\.[A-Za-z0-9\*@$\-_]+)?." "Version","`string `_","1..1"," Constraints: pattern=[0-9]+(\.[0-9]+)*." "UserID",":doc:`/composite-types/UserIDType/index`","0..n","Allows for the specification of identifiers other than the specified DDI identification of the object. This may be a legacy ID from DDI-C, a system specific ID such as for a database or registry, or a non-DDI unique identifier. As the identifier is specific to a system the system must be identified with the UserID structure." "UserAttributePair",":doc:`/composite-types/StandardKeyValuePairType/index`","0..n","A system specific user defined property of the object expressed as a key/value pair. As this is specific to an individual system the use of controlled vocabularies for the key is strongly recommended." "VersionResponsibility","`string `_","0..1","Person or organization within the MaintenanceAgency responsible for the version change. If it is important to retain the affiliation between and individual responsible for the version and his/her agency, it may be included in this notation. This is primarily intended for internal use." "VersionResponsibilityReference",":doc:`/item-types/Agent/index`","0..1","Reference person or organization within the MaintenanceAgency responsible for the version change, as described in an OrganizationScheme. If it is important to retain the affiliation between and individual responsible for the version and his/her agency, a Relation should be created between the individual referenced here and his/her organization. This is primarily intended for internal use. Constraints: assignable subtypes allowed." "VersionRationale",":doc:`/composite-types/VersionRationaleType/index`","0..1","Textual description of the rationale/purpose for the version change and a coded value to provide an internal processing flag within and organization or system. Note that versioning can only take place on objects owned by the specified DDI Agency. If you are creating a local instance of an object from another agency for current or future modification use BasedOnObject. If the changes being made result in what you determine to be new object rather than a version of a previous object, i.e. the change is too extensive to consider it a version of the existing object, create a new object and use BasedOnObject to provide a link to the object or objects that were a basis for the new object." "BasedOnObject",":doc:`/composite-types/BasedOnObjectType/index`","0..1","Use when creating an object that is based on an existing object or objects that are managed by a different agency or when the new object is NOT simply a version change but you wish to maintain a reference to the object that served as a basis for the new object. BasedOnObject may contain references to any number of objects which serve as a basis for this object, a BasedOnRationalDescription of how the content of the referenced object was incorporated or altered, and a BasedOnRationalCode to allow for specific typing of the BasedOnReference according to an external controlled vocabulary." "RelatedOtherMaterialReference",":doc:`/item-types/OtherMaterial/index`","0..n","The inclusion of an existing OtherMaterial by reference. Use for any type of OtherMaterial not specifically addressed by an inline description for such as ExternalAid in QuestionItem." "VersionDate","`cogsDate `_","0..1","Date of version using the union set BaseDateType. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser." "IsPublished","`boolean `_","0..1","Indicates that the maintainable will not be changed without versioning, and is a stable target for referencing." Item Type Hierarchy ~~~~~~~~~~~~~~~~~~~ * :doc:`/item-types/Versionable/index` * :doc:`/item-types/Describable/index` * **Population** Relationships ~~~~~~~~~~~~~ The following identified item types reference this type. .. csv-table:: :header: "Item Type","Property" :widths: 30,70 :doc:`/item-types/CategoryGroup/index`,PopulationReference :doc:`/item-types/CodeListGroup/index`,PopulationReference :doc:`/item-types/ConceptGroup/index`,GroupingPopulationReference :doc:`/item-types/ConceptualVariableGroup/index`,PopulationReference :doc:`/item-types/ControlConstructGroup/index`,PopulationReference :doc:`/item-types/DevelopmentActivityGroup/index`,PopulationReference :doc:`/item-types/GeographicLocationGroup/index`,PopulationReference :doc:`/item-types/GeographicStructureGroup/index`,PopulationReference :doc:`/item-types/Group/index`,PopulationReference :doc:`/item-types/InstructionGroup/index`,PopulationReference :doc:`/item-types/InstrumentGroup/index`,PopulationReference :doc:`/item-types/ManagedRepresentationGroup/index`,PopulationReference :doc:`/item-types/MeasurementConstruct/index`,PopulationReference :doc:`/item-types/MeasurementGroup/index`,PopulationReference :doc:`/item-types/NCube/index`,Attribute/AttachmentRegionReference/PopulationReference :doc:`/item-types/NCube/index`,CoordinateRegion/PopulationReference :doc:`/item-types/NCube/index`,PopulationReference :doc:`/item-types/NCubeGroup/index`,PopulationReference :doc:`/item-types/NCubeInstance/index`,AttachedAttribute/AttributeReference/AttachmentRegionReference/PopulationReference :doc:`/item-types/NCubeInstance/index`,DataItemN/AttachedAttribute/AttributeReference/AttachmentRegionReference/PopulationReference :doc:`/item-types/NCubeInstanceI/index`,AttachedAttributeI/AttributeReference/AttachmentRegionReference/PopulationReference :doc:`/item-types/NCubeInstanceI/index`,DataItemI/AttachedAttribute/AttributeReference/AttachmentRegionReference/PopulationReference :doc:`/item-types/NCubeInstanceT/index`,AttachedAttributeT/AttributeReference/AttachmentRegionReference/PopulationReference :doc:`/item-types/NCubeInstanceT/index`,DataItemT/AttachedAttributeT/AttributeReference/AttachmentRegionReference/PopulationReference :doc:`/item-types/OrganizationGroup/index`,PopulationReference :doc:`/item-types/OtherMaterialGroup/index`,PopulationReference :doc:`/item-types/PhysicalInstanceGroup/index`,PopulationReference :doc:`/item-types/PhysicalStructureGroup/index`,PopulationReference :doc:`/item-types/PopulationGroup/index`,GroupingPopulationReference :doc:`/item-types/PopulationGroup/index`,PopulationReference :doc:`/item-types/PopulationScheme/index`,PopulationReference :doc:`/item-types/ProcessingEventGroup/index`,PopulationReference :doc:`/item-types/ProcessingInstructionGroup/index`,PopulationReference :doc:`/item-types/QualityStandardGroup/index`,PopulationReference :doc:`/item-types/QualityStatementGroup/index`,PopulationReference :doc:`/item-types/QuestionConstruct/index`,PopulationReference :doc:`/item-types/QuestionGroup/index`,PopulationReference :doc:`/item-types/RecordLayoutGroup/index`,PopulationReference :doc:`/item-types/RepresentedVariableGroup/index`,PopulationReference :doc:`/item-types/ResourcePackage/index`,PopulationReference :doc:`/item-types/Sample/index`,PopulationOfConcern/PopulationReference :doc:`/item-types/SampleFrame/index`,PopulationReference :doc:`/item-types/SampleStep/index`,Stratification/StratificationRationale/PopulationReference :doc:`/item-types/SamplingInformationGroup/index`,PopulationReference :doc:`/item-types/SamplingPlan/index`,IntendedSurveyPopulation/PopulationReference :doc:`/item-types/SamplingPlan/index`,IntendedTargetPopulation/PopulationReference :doc:`/item-types/SamplingPlan/index`,StratificationRationale/PopulationReference :doc:`/item-types/SamplingStage/index`,Stratification/StratificationRationale/PopulationReference :doc:`/item-types/StudyUnit/index`,PopulationReference :doc:`/item-types/UnitTypeGroup/index`,PopulationReference :doc:`/item-types/UniverseGroup/index`,GroupingPopulationReference :doc:`/item-types/Variable/index`,PopulationReference :doc:`/item-types/VariableGroup/index`,PopulationReference .. only:: html .. raw:: html
.. image:: ../../images/Population.svg :alt: Relationships for Population :class: cogs-diagram-image dark-light :download:`Download full-size SVG <../../images/Population.svg>` .. raw:: html
.. raw:: html
.. image:: ../../images/Population.dark.svg :alt: Relationships for Population :class: cogs-diagram-image dark-light :download:`Download full-size SVG <../../images/Population.dark.svg>` .. raw:: html
.. only:: not html .. image:: ../../images/Population.svg :alt: Relationships for Population