diff --git a/fsh-generated/fsh-index.json b/fsh-generated/fsh-index.json index ead88216..d5431555 100644 --- a/fsh-generated/fsh-index.json +++ b/fsh-generated/fsh-index.json @@ -144,7 +144,7 @@ "endLine": 65 }, { - "outputFile": "Group-cbtn-family-study.json", + "outputFile": "Group-cbtn-study-family.json", "fshName": "FM-00C8Y7DG", "fshType": "Instance", "fshFile": "examples/family.fsh", @@ -423,14 +423,6 @@ "startLine": 110, "endLine": 116 }, - { - "outputFile": "StructureDefinition-SharedDataModelFamilyStudy.json", - "fshName": "CdmFamilyStudy", - "fshType": "Logical", - "fshFile": "modules/family.fsh", - "startLine": 13, - "endLine": 22 - }, { "outputFile": "StructureDefinition-SharedDataModelPerson.json", "fshName": "CdmPerson", @@ -471,6 +463,14 @@ "startLine": 138, "endLine": 168 }, + { + "outputFile": "StructureDefinition-SharedDataModelStudyFamily.json", + "fshName": "CdmStudyFamily", + "fshType": "Logical", + "fshFile": "modules/family.fsh", + "startLine": 13, + "endLine": 22 + }, { "outputFile": "StructureDefinition-SharedDataModelStudyParticipant.json", "fshName": "CdmStudyParticipant", @@ -527,22 +527,6 @@ "startLine": 127, "endLine": 133 }, - { - "outputFile": "StructureDefinition-family-study-focus.json", - "fshName": "FamilyStudyFocus", - "fshType": "Extension", - "fshFile": "modules/family.fsh", - "startLine": 81, - "endLine": 86 - }, - { - "outputFile": "StructureDefinition-family-study.json", - "fshName": "FamilyStudy", - "fshType": "Extension", - "fshFile": "modules/family.fsh", - "startLine": 118, - "endLine": 125 - }, { "outputFile": "StructureDefinition-family-type.json", "fshName": "FamilyType", @@ -583,14 +567,6 @@ "startLine": 135, "endLine": 148 }, - { - "outputFile": "StructureDefinition-ncpi-family-study.json", - "fshName": "NcpiFamilyStudy", - "fshType": "Profile", - "fshFile": "modules/family.fsh", - "startLine": 88, - "endLine": 106 - }, { "outputFile": "StructureDefinition-ncpi-participant.json", "fshName": "NcpiParticipant", @@ -631,6 +607,14 @@ "startLine": 60, "endLine": 86 }, + { + "outputFile": "StructureDefinition-ncpi-study-family.json", + "fshName": "NcpiStudyFamily", + "fshType": "Profile", + "fshFile": "modules/family.fsh", + "startLine": 88, + "endLine": 106 + }, { "outputFile": "StructureDefinition-research-age-at-last-vital-status.json", "fshName": "AgeAtLastVitalStatus", @@ -727,6 +711,22 @@ "startLine": 2, "endLine": 9 }, + { + "outputFile": "StructureDefinition-study-family-focus.json", + "fshName": "StudyFamilyFocus", + "fshType": "Extension", + "fshFile": "modules/family.fsh", + "startLine": 81, + "endLine": 86 + }, + { + "outputFile": "StructureDefinition-study-family.json", + "fshName": "StudyFamily", + "fshType": "Extension", + "fshFile": "modules/family.fsh", + "startLine": 118, + "endLine": 125 + }, { "outputFile": "ValueSet-collection-type-vs.json", "fshName": "CollectionTypeVS", diff --git a/fsh-generated/fsh-index.txt b/fsh-generated/fsh-index.txt index 21a89f69..60cac740 100644 --- a/fsh-generated/fsh-index.txt +++ b/fsh-generated/fsh-index.txt @@ -17,7 +17,7 @@ Consent-kf-gsr-allowed-access.json kf-gsr-allowed Consent-kf-registered-allowed-access.json kf-registered-allowed-access Instance examples/ResearchStudy-CBTN.fsh 193 - 204 Group-cbtn-family-role-mother.json cbtn-family-role-mother Instance examples/family.fsh 30 - 39 Group-cbtn-family-role-son.json cbtn-family-role-son Instance examples/family.fsh 56 - 65 -Group-cbtn-family-study.json FM-00C8Y7DG Instance examples/family.fsh 13 - 28 +Group-cbtn-study-family.json FM-00C8Y7DG Instance examples/family.fsh 13 - 28 Group-cmg-research-study-bhcmg-consent-group-hmb-npu.json cmg-research-study-bhcmg-consent-group-hmb-npu Instance examples/ResearchStudy-BH-CMG.fsh 89 - 100 Group-cmg-research-study-bhcmg-consent-group-irb-hmb-npu.json cmg-research-study-bhcmg-consent-group-irb-hmb-npu Instance examples/ResearchStudy-BH-CMG.fsh 135 - 146 Group-kf-research-study-cbtn-participants.json kf-research-study-cbtn-participants Instance examples/ResearchStudy-CBTN.fsh 92 - 103 @@ -52,12 +52,12 @@ ResearchSubject-emerge-example-participantstudy.json emerge-example ResearchSubject-pcgc-example-participantstudy.json pcgc-example-participantstudy Instance examples/participant.fsh 208 - 216 StructureDefinition-SharedDataModelFamilyRelationship.json CdmFamilyRelationship Logical modules/family.fsh 153 - 159 StructureDefinition-SharedDataModelFamilyRole.json CdmFamilyRole Logical modules/family.fsh 110 - 116 -StructureDefinition-SharedDataModelFamilyStudy.json CdmFamilyStudy Logical modules/family.fsh 13 - 22 StructureDefinition-SharedDataModelPerson.json CdmPerson Logical modules/participant.fsh 93 - 98 StructureDefinition-SharedDataModelResearchCollection.json CdmResearchCollection Logical modules/research-collection.fsh 39 - 48 StructureDefinition-SharedDataModelResearchDataAccessPolicy.json CdmResearchDataAccessPolicy Logical modules/research-accesss-policy.fsh 113 - 120 StructureDefinition-SharedDataModelResearchParticipant.json CdmResearchParticipant Logical modules/participant.fsh 3 - 16 StructureDefinition-SharedDataModelResearchStudy.json CdmResearchStudy Logical modules/research-study.fsh 138 - 168 +StructureDefinition-SharedDataModelStudyFamily.json CdmStudyFamily Logical modules/family.fsh 13 - 22 StructureDefinition-SharedDataModelStudyParticipant.json CdmStudyParticipant Logical modules/participant.fsh 116 - 122 StructureDefinition-access-policy-description.json AccessPolicyDescription Extension modules/research-accesss-policy.fsh 83 - 90 StructureDefinition-access-policy.json AccessPolicy Extension modules/participant.fsh 124 - 131 @@ -65,19 +65,17 @@ StructureDefinition-access-type.json AccessType StructureDefinition-consanguinity.json Consanguinity Extension modules/family.fsh 73 - 79 StructureDefinition-description.json Description Extension modules/family.fsh 56 - 61 StructureDefinition-family-role.json FamilyRole Extension modules/family.fsh 127 - 133 -StructureDefinition-family-study-focus.json FamilyStudyFocus Extension modules/family.fsh 81 - 86 -StructureDefinition-family-study.json FamilyStudy Extension modules/family.fsh 118 - 125 StructureDefinition-family-type.json FamilyType Extension modules/family.fsh 48 - 54 StructureDefinition-label-extension.json Label Extension extensions/Label.fsh 1 - 13 StructureDefinition-ncpi-Study-Participant.json NcpiStudyParticipant Profile modules/participant.fsh 133 - 145 StructureDefinition-ncpi-family-relationship.json NcpiFamilyRelationship Profile modules/family.fsh 161 - 175 StructureDefinition-ncpi-family-role.json NcpiFamilyRole Profile modules/family.fsh 135 - 148 -StructureDefinition-ncpi-family-study.json NcpiFamilyStudy Profile modules/family.fsh 88 - 106 StructureDefinition-ncpi-participant.json NcpiParticipant Profile modules/participant.fsh 62 - 87 StructureDefinition-ncpi-person.json NcpiPerson Profile modules/participant.fsh 101 - 112 StructureDefinition-ncpi-research-access-policy.json NcpiResearchAccessPolicy Profile modules/research-accesss-policy.fsh 92 - 110 StructureDefinition-ncpi-research-collection.json NcpiResearchCollection Profile modules/research-collection.fsh 20 - 37 StructureDefinition-ncpi-research-study.json NcpiResearchStudy Profile modules/research-study.fsh 60 - 86 +StructureDefinition-ncpi-study-family.json NcpiStudyFamily Profile modules/family.fsh 88 - 106 StructureDefinition-research-age-at-last-vital-status.json AgeAtLastVitalStatus Extension modules/participant.fsh 53 - 60 StructureDefinition-research-date-of-birth-method.json ResearchDateOfBirthMethod Extension modules/participant.fsh 45 - 51 StructureDefinition-research-disease-use-limitation.json ResearchDiseaseUseLimitation Extension modules/research-accesss-policy.fsh 67 - 73 @@ -90,6 +88,8 @@ StructureDefinition-research-study-result.json ResearchStudyR StructureDefinition-research-study-subject-consent.json ResearchStudySubjectConsent Extension modules/research-study-subject.fsh 1 - 5 StructureDefinition-research-study-subject.json ResearchStudySubject Profile modules/research-study-subject.fsh 7 - 15 StructureDefinition-research-web-Link.json ResearchWebLink Extension extensions/ResearchWebLink.fsh 2 - 9 +StructureDefinition-study-family-focus.json StudyFamilyFocus Extension modules/family.fsh 81 - 86 +StructureDefinition-study-family.json StudyFamily Extension modules/family.fsh 118 - 125 ValueSet-collection-type-vs.json CollectionTypeVS ValueSet modules/research-collection.fsh 13 - 18 ValueSet-consanguinity-assertion-vs.json ConsanguinityAssertionVS ValueSet modules/family.fsh 63 - 71 ValueSet-mesh-terms.json MeshTerms ValueSet modules/research-accesss-policy.fsh 54 - 60 diff --git a/fsh-generated/includes/fsh-link-references.md b/fsh-generated/includes/fsh-link-references.md index 7f0dba4b..836b2eba 100644 --- a/fsh-generated/includes/fsh-link-references.md +++ b/fsh-generated/includes/fsh-link-references.md @@ -27,17 +27,13 @@ [cbtn-example-participantstudy]: ResearchSubject-cbtn-example-participantstudy.html [emerge-example-participantstudy]: ResearchSubject-emerge-example-participantstudy.html [pcgc-example-participantstudy]: ResearchSubject-pcgc-example-participantstudy.html -[cbtn-family-study]: Group-cbtn-family-study.html +[cbtn-study-family]: Group-cbtn-study-family.html [PT-KZG2CZ95]: Patient-PT-KZG2CZ95.html [cbtn-example-person]: Person-cbtn-example-person.html [6812345]: Patient-6812345.html [emerge-example-person]: Person-emerge-example-person.html [PT-005B7CZ4]: Patient-PT-005B7CZ4.html [pcgc-example-person]: Person-pcgc-example-person.html -[Description]: StructureDefinition-description.html -[FamilyRole]: StructureDefinition-family-role.html -[FamilyStudyFocus]: StructureDefinition-family-study-focus.html -[FamilyStudy]: StructureDefinition-family-study.html [FamilyType]: StructureDefinition-family-type.html [NcpiFamilyTypesVS]: ValueSet-ncpi-family-types-vs.html [kf-gsr-allowed-access]: Consent-kf-gsr-allowed-access.html @@ -51,7 +47,6 @@ [SD-BHJXBDQK]: ResearchStudy-SD-BHJXBDQK.html [SD-PREASA7S]: ResearchStudy-SD-PREASA7S.html [phv00407460.v2]: ResearchStudy-phv00407460.v2.html -[NcpiFamilyStudy]: StructureDefinition-ncpi-family-study.html [NcpiFamilyTypes]: CodeSystem-ncpi-family-types.html [Ncpi]: CodeSystem-ncpi.html [NcpiParticipant]: StructureDefinition-ncpi-participant.html @@ -60,6 +55,7 @@ [NcpiResearchCollection]: StructureDefinition-ncpi-research-collection.html [NcpiResearchStudy]: StructureDefinition-ncpi-research-study.html [ResearchStudyGroup]: StructureDefinition-research-study-group.html +[NcpiStudyFamily]: StructureDefinition-ncpi-study-family.html [NcpiStudyParticipant]: StructureDefinition-ncpi-Study-Participant.html [cmg-research-study-bhcmg-consent-group-hmb-npu]: Group-cmg-research-study-bhcmg-consent-group-hmb-npu.html [cmg-research-study-subject-cmg-hmb-npu]: ResearchStudy-cmg-research-study-subject-cmg-hmb-npu.html @@ -85,14 +81,18 @@ [NcpiFamilyRelationship]: StructureDefinition-ncpi-family-relationship.html [NcpiFamilyRole]: StructureDefinition-ncpi-family-role.html [CdmFamilyRole]: StructureDefinition-SharedDataModelFamilyRole.html -[CdmFamilyStudy]: StructureDefinition-SharedDataModelFamilyStudy.html -[CdmFamilyRelationship]: StructureDefinition-SharedDataModelFamilyRelationship.html [CdmResearchCollection]: StructureDefinition-SharedDataModelResearchCollection.html [CdmResearchDataAccessPolicy]: StructureDefinition-SharedDataModelResearchDataAccessPolicy.html [CdmStudyParticipant]: StructureDefinition-SharedDataModelStudyParticipant.html [CdmResearchParticipant]: StructureDefinition-SharedDataModelResearchParticipant.html [CdmPerson]: StructureDefinition-SharedDataModelPerson.html [CdmResearchStudy]: StructureDefinition-SharedDataModelResearchStudy.html +[CdmStudyFamily]: StructureDefinition-SharedDataModelStudyFamily.html +[CdmFamilyRelationship]: StructureDefinition-SharedDataModelFamilyRelationship.html +[Description]: StructureDefinition-description.html +[FamilyRole]: StructureDefinition-family-role.html +[StudyFamilyFocus]: StructureDefinition-study-family-focus.html +[StudyFamily]: StructureDefinition-study-family.html [StudyNameTypeVS]: ValueSet-study-name-type-vs.html [StudyNameType]: CodeSystem-study-name-type.html [StudyPersonnelRoleVS]: ValueSet-study-personnel-role-vs.html diff --git a/fsh-generated/resources/Group-cbtn-family-role-mother.json b/fsh-generated/resources/Group-cbtn-family-role-mother.json index c43f47dc..928059e6 100644 --- a/fsh-generated/resources/Group-cbtn-family-role-mother.json +++ b/fsh-generated/resources/Group-cbtn-family-role-mother.json @@ -15,9 +15,9 @@ ], "extension": [ { - "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-study", + "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/study-family", "valueReference": { - "reference": "Group/cbtn-family-study" + "reference": "Group/cbtn-study-family" } }, { diff --git a/fsh-generated/resources/Group-cbtn-family-role-son.json b/fsh-generated/resources/Group-cbtn-family-role-son.json index c94307bb..ebea6328 100644 --- a/fsh-generated/resources/Group-cbtn-family-role-son.json +++ b/fsh-generated/resources/Group-cbtn-family-role-son.json @@ -15,9 +15,9 @@ ], "extension": [ { - "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-study", + "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/study-family", "valueReference": { - "reference": "Group/cbtn-family-study" + "reference": "Group/cbtn-study-family" } }, { diff --git a/fsh-generated/resources/Group-cbtn-family-study.json b/fsh-generated/resources/Group-cbtn-study-family.json similarity index 91% rename from fsh-generated/resources/Group-cbtn-family-study.json rename to fsh-generated/resources/Group-cbtn-study-family.json index 6c3883ce..6dc66019 100644 --- a/fsh-generated/resources/Group-cbtn-family-study.json +++ b/fsh-generated/resources/Group-cbtn-study-family.json @@ -1,9 +1,9 @@ { "resourceType": "Group", - "id": "cbtn-family-study", + "id": "cbtn-study-family", "meta": { "profile": [ - "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-family-study" + "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-study-family" ] }, "identifier": [ @@ -26,7 +26,7 @@ } }, { - "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-study-focus", + "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/study-family-focus", "valueCodeableConcept": { "coding": [ { diff --git a/fsh-generated/resources/ImplementationGuide-ncpi-fhir-implementation-guide-v2.json b/fsh-generated/resources/ImplementationGuide-ncpi-fhir-implementation-guide-v2.json index 5601a4fa..0a3b187d 100644 --- a/fsh-generated/resources/ImplementationGuide-ncpi-fhir-implementation-guide-v2.json +++ b/fsh-generated/resources/ImplementationGuide-ncpi-fhir-implementation-guide-v2.json @@ -210,7 +210,7 @@ "reference": "ValueSet/consanguinity-assertion-vs" }, "name": "Consanguinity Value Codes", - "description": "List of codes indicates the level of known consanguinity (blood relation) within a family study.", + "description": "List of codes indicates the level of known consanguinity (blood relation) within a study family.", "exampleBoolean": false }, { @@ -271,11 +271,11 @@ }, { "reference": { - "reference": "Group/cbtn-family-study" + "reference": "Group/cbtn-study-family" }, "name": "Example patients based on data from CBTN", "description": "Example patients based on data from CBTN.", - "exampleCanonical": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-family-study" + "exampleCanonical": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-study-family" }, { "reference": { @@ -325,38 +325,6 @@ "description": "Example patients based on data from PCGC", "exampleCanonical": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-person" }, - { - "reference": { - "reference": "StructureDefinition/description" - }, - "name": "Family Study Description", - "description": "Free text describing the family study, such as potential inheritance or details about consanguinity", - "exampleBoolean": false - }, - { - "reference": { - "reference": "StructureDefinition/family-role" - }, - "name": "Family Study Focus", - "description": "Extension containing Family Role", - "exampleBoolean": false - }, - { - "reference": { - "reference": "StructureDefinition/family-study-focus" - }, - "name": "Family Study Focus Extension", - "description": "Extension containing Family Study Focus", - "exampleBoolean": false - }, - { - "reference": { - "reference": "StructureDefinition/family-study" - }, - "name": "Family Study Reference", - "description": "Extension containing Family Study Reference", - "exampleBoolean": false - }, { "reference": { "reference": "StructureDefinition/family-type" @@ -461,14 +429,6 @@ "description": "Genomic Summary Results (GSR) Allowed Access", "exampleCanonical": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/research-study-subject" }, - { - "reference": { - "reference": "StructureDefinition/ncpi-family-study" - }, - "name": "NCPI Family Study", - "description": "Family Study", - "exampleBoolean": false - }, { "reference": { "reference": "CodeSystem/ncpi-family-types" @@ -533,6 +493,14 @@ "description": "Grouping subject participation within a research study is helpful to provide definitive lists of participants that fit a specific criteria such as *All Participants* or *Participants From a Particular Consent Group*, etc. ", "exampleBoolean": false }, + { + "reference": { + "reference": "StructureDefinition/ncpi-study-family" + }, + "name": "NCPI Study Family", + "description": "Study Family", + "exampleBoolean": false + }, { "reference": { "reference": "StructureDefinition/ncpi-Study-Participant" @@ -733,22 +701,6 @@ "description": "The **Shared Data Model for Family Role**", "exampleBoolean": false }, - { - "reference": { - "reference": "StructureDefinition/SharedDataModelFamilyStudy" - }, - "name": "Shared Data Model for Family Study", - "description": "The **Shared Data Model for Family Study**", - "exampleBoolean": false - }, - { - "reference": { - "reference": "StructureDefinition/SharedDataModelFamilyRelationship" - }, - "name": "Shared Data Model for Family Study", - "description": "The **Shared Data Model for Family Study**", - "exampleBoolean": false - }, { "reference": { "reference": "StructureDefinition/SharedDataModelResearchCollection" @@ -797,6 +749,54 @@ "description": "The **Shared Data Model for Research Study** represents the understanding of what a Research Study is from the context of users and authors of the NCPI FHIR IG.", "exampleBoolean": false }, + { + "reference": { + "reference": "StructureDefinition/SharedDataModelStudyFamily" + }, + "name": "Shared Data Model for Study Family", + "description": "The **Shared Data Model for Study Family**", + "exampleBoolean": false + }, + { + "reference": { + "reference": "StructureDefinition/SharedDataModelFamilyRelationship" + }, + "name": "Shared Data Model for Study Family", + "description": "The **Shared Data Model for Study Family**", + "exampleBoolean": false + }, + { + "reference": { + "reference": "StructureDefinition/description" + }, + "name": "Study Family Description", + "description": "Free text describing the study family, such as potential inheritance or details about consanguinity", + "exampleBoolean": false + }, + { + "reference": { + "reference": "StructureDefinition/family-role" + }, + "name": "Study Family Focus", + "description": "Extension containing Family Role", + "exampleBoolean": false + }, + { + "reference": { + "reference": "StructureDefinition/study-family-focus" + }, + "name": "Study Family Focus Extension", + "description": "Extension containing Study Family Focus", + "exampleBoolean": false + }, + { + "reference": { + "reference": "StructureDefinition/study-family" + }, + "name": "Study Family Reference", + "description": "Extension containing Study Family Reference", + "exampleBoolean": false + }, { "reference": { "reference": "ValueSet/study-name-type-vs" diff --git a/fsh-generated/resources/StructureDefinition-SharedDataModelFamilyRelationship.json b/fsh-generated/resources/StructureDefinition-SharedDataModelFamilyRelationship.json index 771bbde8..85ff05b8 100644 --- a/fsh-generated/resources/StructureDefinition-SharedDataModelFamilyRelationship.json +++ b/fsh-generated/resources/StructureDefinition-SharedDataModelFamilyRelationship.json @@ -3,9 +3,9 @@ "id": "SharedDataModelFamilyRelationship", "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/SharedDataModelFamilyRelationship", "name": "CdmFamilyRelationship", - "title": "Shared Data Model for Family Study", + "title": "Shared Data Model for Study Family", "status": "draft", - "description": "The **Shared Data Model for Family Study**", + "description": "The **Shared Data Model for Study Family**", "fhirVersion": "4.3.0", "kind": "logical", "abstract": false, @@ -17,8 +17,8 @@ { "id": "SharedDataModelFamilyRelationship", "path": "SharedDataModelFamilyRelationship", - "short": "Shared Data Model for Family Study", - "definition": "The **Shared Data Model for Family Study**" + "short": "Shared Data Model for Study Family", + "definition": "The **Shared Data Model for Study Family**" }, { "id": "SharedDataModelFamilyRelationship.subject", diff --git a/fsh-generated/resources/StructureDefinition-SharedDataModelFamilyRole.json b/fsh-generated/resources/StructureDefinition-SharedDataModelFamilyRole.json index 4fde556e..064682d1 100644 --- a/fsh-generated/resources/StructureDefinition-SharedDataModelFamilyRole.json +++ b/fsh-generated/resources/StructureDefinition-SharedDataModelFamilyRole.json @@ -34,10 +34,10 @@ ] }, { - "id": "SharedDataModelFamilyRole.familyStudy", - "path": "SharedDataModelFamilyRole.familyStudy", - "short": "The family study this participant is part of", - "definition": "The family study this participant is part of", + "id": "SharedDataModelFamilyRole.studyFamily", + "path": "SharedDataModelFamilyRole.studyFamily", + "short": "The study family this participant is part of", + "definition": "The study family this participant is part of", "min": 1, "max": "1", "type": [ diff --git a/fsh-generated/resources/StructureDefinition-SharedDataModelFamilyStudy.json b/fsh-generated/resources/StructureDefinition-SharedDataModelFamilyStudy.json deleted file mode 100644 index 16e58d95..00000000 --- a/fsh-generated/resources/StructureDefinition-SharedDataModelFamilyStudy.json +++ /dev/null @@ -1,103 +0,0 @@ -{ - "resourceType": "StructureDefinition", - "id": "SharedDataModelFamilyStudy", - "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/SharedDataModelFamilyStudy", - "name": "CdmFamilyStudy", - "title": "Shared Data Model for Family Study", - "status": "draft", - "description": "The **Shared Data Model for Family Study**", - "fhirVersion": "4.3.0", - "kind": "logical", - "abstract": false, - "type": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/SharedDataModelFamilyStudy", - "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base", - "derivation": "specialization", - "differential": { - "element": [ - { - "id": "SharedDataModelFamilyStudy", - "path": "SharedDataModelFamilyStudy", - "short": "Shared Data Model for Family Study", - "definition": "The **Shared Data Model for Family Study**" - }, - { - "id": "SharedDataModelFamilyStudy.familyID", - "path": "SharedDataModelFamilyStudy.familyID", - "short": "Unique family study identifier. System identifier used for internal references.", - "definition": "Unique family study identifier. System identifier used for internal references.", - "min": 1, - "max": "1", - "type": [ - { - "code": "string" - } - ] - }, - { - "id": "SharedDataModelFamilyStudy.externalID", - "path": "SharedDataModelFamilyStudy.externalID", - "short": "Family study identifier. System identifier used for external references.", - "definition": "Family study identifier. System identifier used for external references.", - "min": 0, - "max": "*", - "type": [ - { - "code": "string" - } - ] - }, - { - "id": "SharedDataModelFamilyStudy.familyType", - "path": "SharedDataModelFamilyStudy.familyType", - "short": "Describes the 'type' of family study, eg, trio. ", - "definition": "Describes the 'type' of family study, eg, trio. ", - "min": 0, - "max": "1", - "type": [ - { - "code": "code" - } - ] - }, - { - "id": "SharedDataModelFamilyStudy.description", - "path": "SharedDataModelFamilyStudy.description", - "short": "Free text describing the family study, such as potential inheritance or details about consanguinity", - "definition": "Free text describing the family study, such as potential inheritance or details about consanguinity", - "min": 0, - "max": "1", - "type": [ - { - "code": "string" - } - ] - }, - { - "id": "SharedDataModelFamilyStudy.consanguinity", - "path": "SharedDataModelFamilyStudy.consanguinity", - "short": "Is there known or suspected consanguinity in this family study?", - "definition": "Is there known or suspected consanguinity in this family study?", - "min": 0, - "max": "1", - "type": [ - { - "code": "code" - } - ] - }, - { - "id": "SharedDataModelFamilyStudy.familyStudyFocus", - "path": "SharedDataModelFamilyStudy.familyStudyFocus", - "short": "What is this family study investigating? EG, a specific condition", - "definition": "What is this family study investigating? EG, a specific condition", - "min": 0, - "max": "1", - "type": [ - { - "code": "code" - } - ] - } - ] - } -} diff --git a/fsh-generated/resources/StructureDefinition-SharedDataModelStudyFamily.json b/fsh-generated/resources/StructureDefinition-SharedDataModelStudyFamily.json new file mode 100644 index 00000000..d919711a --- /dev/null +++ b/fsh-generated/resources/StructureDefinition-SharedDataModelStudyFamily.json @@ -0,0 +1,103 @@ +{ + "resourceType": "StructureDefinition", + "id": "SharedDataModelStudyFamily", + "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/SharedDataModelStudyFamily", + "name": "CdmStudyFamily", + "title": "Shared Data Model for Study Family", + "status": "draft", + "description": "The **Shared Data Model for Study Family**", + "fhirVersion": "4.3.0", + "kind": "logical", + "abstract": false, + "type": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/SharedDataModelStudyFamily", + "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base", + "derivation": "specialization", + "differential": { + "element": [ + { + "id": "SharedDataModelStudyFamily", + "path": "SharedDataModelStudyFamily", + "short": "Shared Data Model for Study Family", + "definition": "The **Shared Data Model for Study Family**" + }, + { + "id": "SharedDataModelStudyFamily.familyID", + "path": "SharedDataModelStudyFamily.familyID", + "short": "Unique study family identifier. System identifier used for internal references.", + "definition": "Unique study family identifier. System identifier used for internal references.", + "min": 1, + "max": "1", + "type": [ + { + "code": "string" + } + ] + }, + { + "id": "SharedDataModelStudyFamily.externalID", + "path": "SharedDataModelStudyFamily.externalID", + "short": "Study family identifier. System identifier used for external references.", + "definition": "Study family identifier. System identifier used for external references.", + "min": 0, + "max": "*", + "type": [ + { + "code": "string" + } + ] + }, + { + "id": "SharedDataModelStudyFamily.familyType", + "path": "SharedDataModelStudyFamily.familyType", + "short": "Describes the 'type' of study family, eg, trio. ", + "definition": "Describes the 'type' of study family, eg, trio. ", + "min": 0, + "max": "1", + "type": [ + { + "code": "code" + } + ] + }, + { + "id": "SharedDataModelStudyFamily.description", + "path": "SharedDataModelStudyFamily.description", + "short": "Free text describing the study family, such as potential inheritance or details about consanguinity", + "definition": "Free text describing the study family, such as potential inheritance or details about consanguinity", + "min": 0, + "max": "1", + "type": [ + { + "code": "string" + } + ] + }, + { + "id": "SharedDataModelStudyFamily.consanguinity", + "path": "SharedDataModelStudyFamily.consanguinity", + "short": "Is there known or suspected consanguinity in this study family?", + "definition": "Is there known or suspected consanguinity in this study family?", + "min": 0, + "max": "1", + "type": [ + { + "code": "code" + } + ] + }, + { + "id": "SharedDataModelStudyFamily.studyFamilyFocus", + "path": "SharedDataModelStudyFamily.studyFamilyFocus", + "short": "What is this study family investigating? EG, a specific condition", + "definition": "What is this study family investigating? EG, a specific condition", + "min": 0, + "max": "1", + "type": [ + { + "code": "code" + } + ] + } + ] + } +} diff --git a/fsh-generated/resources/StructureDefinition-consanguinity.json b/fsh-generated/resources/StructureDefinition-consanguinity.json index f5d41430..25494737 100644 --- a/fsh-generated/resources/StructureDefinition-consanguinity.json +++ b/fsh-generated/resources/StructureDefinition-consanguinity.json @@ -39,7 +39,7 @@ { "id": "Extension.value[x]", "path": "Extension.value[x]", - "short": "Is there known or suspected consanguinity in this family study?", + "short": "Is there known or suspected consanguinity in this study family?", "type": [ { "code": "CodeableConcept" diff --git a/fsh-generated/resources/StructureDefinition-description.json b/fsh-generated/resources/StructureDefinition-description.json index dadf5ba7..39c42c87 100644 --- a/fsh-generated/resources/StructureDefinition-description.json +++ b/fsh-generated/resources/StructureDefinition-description.json @@ -3,9 +3,9 @@ "id": "description", "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/description", "name": "Description", - "title": "Family Study Description", + "title": "Study Family Description", "status": "draft", - "description": "Free text describing the family study, such as potential inheritance or details about consanguinity", + "description": "Free text describing the study family, such as potential inheritance or details about consanguinity", "fhirVersion": "4.3.0", "kind": "complex-type", "abstract": false, @@ -23,8 +23,8 @@ { "id": "Extension", "path": "Extension", - "short": "Family Study Description", - "definition": "Free text describing the family study, such as potential inheritance or details about consanguinity" + "short": "Study Family Description", + "definition": "Free text describing the study family, such as potential inheritance or details about consanguinity" }, { "id": "Extension.extension", diff --git a/fsh-generated/resources/StructureDefinition-family-role.json b/fsh-generated/resources/StructureDefinition-family-role.json index f5ff7db9..8a028e25 100644 --- a/fsh-generated/resources/StructureDefinition-family-role.json +++ b/fsh-generated/resources/StructureDefinition-family-role.json @@ -3,7 +3,7 @@ "id": "family-role", "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-role", "name": "FamilyRole", - "title": "Family Study Focus", + "title": "Study Family Focus", "status": "draft", "description": "Extension containing Family Role", "fhirVersion": "4.3.0", @@ -23,7 +23,7 @@ { "id": "Extension", "path": "Extension", - "short": "Family Study Focus", + "short": "Study Family Focus", "definition": "Extension containing Family Role" }, { diff --git a/fsh-generated/resources/StructureDefinition-family-type.json b/fsh-generated/resources/StructureDefinition-family-type.json index 3ab12ce0..07c154a3 100644 --- a/fsh-generated/resources/StructureDefinition-family-type.json +++ b/fsh-generated/resources/StructureDefinition-family-type.json @@ -39,7 +39,7 @@ { "id": "Extension.value[x]", "path": "Extension.value[x]", - "short": "Describes the 'type' of family study, eg, trio.", + "short": "Describes the 'type' of study family, eg, trio.", "type": [ { "code": "CodeableConcept" diff --git a/fsh-generated/resources/StructureDefinition-ncpi-family-role.json b/fsh-generated/resources/StructureDefinition-ncpi-family-role.json index c2e84719..e1b934be 100644 --- a/fsh-generated/resources/StructureDefinition-ncpi-family-role.json +++ b/fsh-generated/resources/StructureDefinition-ncpi-family-role.json @@ -30,17 +30,17 @@ } }, { - "id": "Group.extension:family-study", + "id": "Group.extension:study-family", "path": "Group.extension", - "sliceName": "family-study", - "short": "The family study this participant is part of", + "sliceName": "study-family", + "short": "The study family this participant is part of", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ - "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-study" + "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/study-family" ] } ] diff --git a/fsh-generated/resources/StructureDefinition-ncpi-family-study.json b/fsh-generated/resources/StructureDefinition-ncpi-study-family.json similarity index 84% rename from fsh-generated/resources/StructureDefinition-ncpi-family-study.json rename to fsh-generated/resources/StructureDefinition-ncpi-study-family.json index 774025be..cd58ec97 100644 --- a/fsh-generated/resources/StructureDefinition-ncpi-family-study.json +++ b/fsh-generated/resources/StructureDefinition-ncpi-study-family.json @@ -1,12 +1,12 @@ { "resourceType": "StructureDefinition", - "id": "ncpi-family-study", - "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-family-study", + "id": "ncpi-study-family", + "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-study-family", "version": "0.1.0", - "name": "NcpiFamilyStudy", - "title": "NCPI Family Study", + "name": "NcpiStudyFamily", + "title": "NCPI Study Family", "status": "draft", - "description": "Family Study", + "description": "Study Family", "fhirVersion": "4.3.0", "kind": "resource", "abstract": false, @@ -39,7 +39,7 @@ "id": "Group.extension:family-type", "path": "Group.extension", "sliceName": "family-type", - "short": "Describes the 'type' of family study, eg, trio.", + "short": "Describes the 'type' of study family, eg, trio.", "min": 0, "max": "1", "type": [ @@ -55,7 +55,7 @@ "id": "Group.extension:description", "path": "Group.extension", "sliceName": "description", - "short": "Free text describing the family study, such as potential inheritance or details about consanguinity", + "short": "Free text describing the study family, such as potential inheritance or details about consanguinity", "min": 0, "max": "1", "type": [ @@ -71,7 +71,7 @@ "id": "Group.extension:consanguinity", "path": "Group.extension", "sliceName": "consanguinity", - "short": "Is there known or suspected consanguinity in this family study?", + "short": "Is there known or suspected consanguinity in this study family?", "min": 0, "max": "1", "type": [ @@ -84,17 +84,17 @@ ] }, { - "id": "Group.extension:family-study-focus", + "id": "Group.extension:study-family-focus", "path": "Group.extension", - "sliceName": "family-study-focus", - "short": "What is this family study investigating? EG, a specific condition", + "sliceName": "study-family-focus", + "short": "What is this study family investigating? EG, a specific condition", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ - "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-study-focus" + "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/study-family-focus" ] } ] diff --git a/fsh-generated/resources/StructureDefinition-family-study-focus.json b/fsh-generated/resources/StructureDefinition-study-family-focus.json similarity index 70% rename from fsh-generated/resources/StructureDefinition-family-study-focus.json rename to fsh-generated/resources/StructureDefinition-study-family-focus.json index a56f6f73..6b9fd619 100644 --- a/fsh-generated/resources/StructureDefinition-family-study-focus.json +++ b/fsh-generated/resources/StructureDefinition-study-family-focus.json @@ -1,11 +1,11 @@ { "resourceType": "StructureDefinition", - "id": "family-study-focus", - "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-study-focus", - "name": "FamilyStudyFocus", - "title": "Family Study Focus Extension", + "id": "study-family-focus", + "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/study-family-focus", + "name": "StudyFamilyFocus", + "title": "Study Family Focus Extension", "status": "draft", - "description": "Extension containing Family Study Focus", + "description": "Extension containing Study Family Focus", "fhirVersion": "4.3.0", "kind": "complex-type", "abstract": false, @@ -23,8 +23,8 @@ { "id": "Extension", "path": "Extension", - "short": "Family Study Focus Extension", - "definition": "Extension containing Family Study Focus" + "short": "Study Family Focus Extension", + "definition": "Extension containing Study Family Focus" }, { "id": "Extension.extension", @@ -34,12 +34,12 @@ { "id": "Extension.url", "path": "Extension.url", - "fixedUri": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-study-focus" + "fixedUri": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/study-family-focus" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", - "short": "What is this family study investigating? EG, a specific condition", + "short": "What is this study family investigating? EG, a specific condition", "type": [ { "code": "CodeableConcept" diff --git a/fsh-generated/resources/StructureDefinition-family-study.json b/fsh-generated/resources/StructureDefinition-study-family.json similarity index 76% rename from fsh-generated/resources/StructureDefinition-family-study.json rename to fsh-generated/resources/StructureDefinition-study-family.json index 836cde13..09a7fbd2 100644 --- a/fsh-generated/resources/StructureDefinition-family-study.json +++ b/fsh-generated/resources/StructureDefinition-study-family.json @@ -1,11 +1,11 @@ { "resourceType": "StructureDefinition", - "id": "family-study", - "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-study", - "name": "FamilyStudy", - "title": "Family Study Reference", + "id": "study-family", + "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/study-family", + "name": "StudyFamily", + "title": "Study Family Reference", "status": "draft", - "description": "Extension containing Family Study Reference", + "description": "Extension containing Study Family Reference", "fhirVersion": "4.3.0", "kind": "complex-type", "abstract": false, @@ -23,8 +23,8 @@ { "id": "Extension", "path": "Extension", - "short": "Family Study Reference", - "definition": "Extension containing Family Study Reference" + "short": "Study Family Reference", + "definition": "Extension containing Study Family Reference" }, { "id": "Extension.extension", @@ -34,7 +34,7 @@ { "id": "Extension.url", "path": "Extension.url", - "fixedUri": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/family-study" + "fixedUri": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/study-family" }, { "id": "Extension.value[x]", @@ -44,7 +44,7 @@ { "code": "Reference", "targetProfile": [ - "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-family-study" + "https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-study-family" ] } ] diff --git a/fsh-generated/resources/ValueSet-consanguinity-assertion-vs.json b/fsh-generated/resources/ValueSet-consanguinity-assertion-vs.json index 190ea7a1..cbac396b 100644 --- a/fsh-generated/resources/ValueSet-consanguinity-assertion-vs.json +++ b/fsh-generated/resources/ValueSet-consanguinity-assertion-vs.json @@ -4,7 +4,7 @@ "name": "ConsanguinityAssertionVS", "id": "consanguinity-assertion-vs", "title": "Consanguinity Value Codes", - "description": "List of codes indicates the level of known consanguinity (blood relation) within a family study.", + "description": "List of codes indicates the level of known consanguinity (blood relation) within a study family.", "url": "https://nih-ncpi.github.io/ncpi-fhir-ig-2/ValueSet/consanguinity-assertion-vs", "experimental": false, "compose": { diff --git a/input/fsh/examples/family.fsh b/input/fsh/examples/family.fsh index 815e941e..36099b3a 100644 --- a/input/fsh/examples/family.fsh +++ b/input/fsh/examples/family.fsh @@ -1,7 +1,7 @@ /* Examples for: -* NcpiFamilyStudy +* NcpiStudyFamily * NcpiFamilyRole * NcpiFamilyRelationship @@ -11,11 +11,11 @@ Examples for: // Example 1 Instance: FM-00C8Y7DG -InstanceOf: NcpiFamilyStudy +InstanceOf: NcpiStudyFamily Title: "Example patients based on data from CBTN" Usage: #example Description: "Example patients based on data from CBTN." -* id = "cbtn-family-study" +* id = "cbtn-study-family" * identifier[0] * system = "https://cbtn.org/" * value = "FM-00C8Y7DG" @@ -25,7 +25,7 @@ Description: "Example patients based on data from CBTN." * extension[family-type].valueCodeableConcept = $ncpi-family-types#Trio "Trio" // * extension[desctiption].valueMarkdown = "Potential inheritance details" // * extension[consanguinity].valueCodeableConcept = $snomedct_us#261665006 "Unknown" -* extension[family-study-focus].valueCodeableConcept = $mondo#0004992 "Cancer" +* extension[study-family-focus].valueCodeableConcept = $mondo#0004992 "Cancer" Instance: cbtn-family-role-mother InstanceOf: NcpiFamilyRole @@ -33,7 +33,7 @@ Title: "An example family role based on data from CBTN" Usage: #example Description: "An example family role based on data from CBTN." * member.entity = Reference(PT-KZG2CZ95) -* extension[family-study].valueReference = Reference(FM-00C8Y7DG) +* extension[study-family].valueReference = Reference(FM-00C8Y7DG) * extension[family-role].valueCodeableConcept = $family-role-code#MTH "mother" * type = #person // Required by Group with required VS * actual = true // Required by Group @@ -51,7 +51,7 @@ Description: "An example family relationship based on data from CBTN." // Example 2 -// This example uses the Family Study defined above. +// This example uses the Study Family defined above. Instance: cbtn-family-role-son InstanceOf: NcpiFamilyRole @@ -59,7 +59,7 @@ Title: "An example family role based on data from CBTN" Usage: #example Description: "An example family role based on data from CBTN." * member.entity = Reference(PT-005B7CZ4) -* extension[family-study].valueReference = Reference(FM-00C8Y7DG) +* extension[study-family].valueReference = Reference(FM-00C8Y7DG) * extension[family-role].valueCodeableConcept = $family-role-code#SON "natural son" * type = #person // Required by Group with required VS * actual = true // Required by Group diff --git a/input/fsh/modules/family.fsh b/input/fsh/modules/family.fsh index 664bacc7..7cac6154 100644 --- a/input/fsh/modules/family.fsh +++ b/input/fsh/modules/family.fsh @@ -2,24 +2,24 @@ Family Module Logical models, profiles, extensions and valuesets for: -* NcpiFamilyStudy +* NcpiStudyFamily * NcpiFamilyRole * NcpiFamilyRelationship */ -// Family Study +// Study Family -Logical: CdmFamilyStudy -Id: SharedDataModelFamilyStudy -Title: "Shared Data Model for Family Study" -Description: "The **Shared Data Model for Family Study**" -* familyID 1..1 string "Unique family study identifier. System identifier used for internal references." -* externalID 0..* string "Family study identifier. System identifier used for external references." -* familyType 0..1 code "Describes the 'type' of family study, eg, trio. " -* description 0..1 string "Free text describing the family study, such as potential inheritance or details about consanguinity" -* consanguinity 0..1 code "Is there known or suspected consanguinity in this family study?" -* familyStudyFocus 0..1 code "What is this family study investigating? EG, a specific condition" +Logical: CdmStudyFamily +Id: SharedDataModelStudyFamily +Title: "Shared Data Model for Study Family" +Description: "The **Shared Data Model for Study Family**" +* familyID 1..1 string "Unique study family identifier. System identifier used for internal references." +* externalID 0..* string "Study family identifier. System identifier used for external references." +* familyType 0..1 code "Describes the 'type' of study family, eg, trio. " +* description 0..1 string "Free text describing the study family, such as potential inheritance or details about consanguinity" +* consanguinity 0..1 code "Is there known or suspected consanguinity in this study family?" +* studyFamilyFocus 0..1 code "What is this study family investigating? EG, a specific condition" CodeSystem: NcpiFamilyTypes Id: ncpi-family-types @@ -50,20 +50,20 @@ Id: family-type Title: "Family Type Extension" Description: "Extension containing Family Type" * value[x] only CodeableConcept -* valueCodeableConcept ^short = "Describes the 'type' of family study, eg, trio." +* valueCodeableConcept ^short = "Describes the 'type' of study family, eg, trio." * valueCodeableConcept from ncpi-family-types-vs (extensible) Extension: Description Id: description -Title: "Family Study Description" -Description: "Free text describing the family study, such as potential inheritance or details about consanguinity" +Title: "Study Family Description" +Description: "Free text describing the study family, such as potential inheritance or details about consanguinity" * value[x] only markdown * valueMarkdown 0..1 ValueSet: ConsanguinityAssertionVS Id: consanguinity-assertion-vs Title: "Consanguinity Value Codes" -Description: "List of codes indicates the level of known consanguinity (blood relation) within a family study." +Description: "List of codes indicates the level of known consanguinity (blood relation) within a study family." * ^experimental = false * $snomedct_us#428263003 "NOT suspected" * $snomedct_us#415684004 "Suspected" @@ -76,20 +76,20 @@ Title: "Consanguinity Extension" Description: "Extension containing Consanguinity" * value[x] only CodeableConcept * valueCodeableConcept from consanguinity-assertion-vs (extensible) -* valueCodeableConcept ^short = "Is there known or suspected consanguinity in this family study?" +* valueCodeableConcept ^short = "Is there known or suspected consanguinity in this study family?" -Extension: FamilyStudyFocus -Id: family-study-focus -Title: "Family Study Focus Extension" -Description: "Extension containing Family Study Focus" +Extension: StudyFamilyFocus +Id: study-family-focus +Title: "Study Family Focus Extension" +Description: "Extension containing Study Family Focus" * value[x] only CodeableConcept -* valueCodeableConcept ^short = "What is this family study investigating? EG, a specific condition" +* valueCodeableConcept ^short = "What is this study family investigating? EG, a specific condition" -Profile: NcpiFamilyStudy +Profile: NcpiStudyFamily Parent: Group -Id: ncpi-family-study -Title: "NCPI Family Study" -Description: "Family Study" +Id: ncpi-study-family +Title: "NCPI Study Family" +Description: "Study Family" * ^version = "0.1.0" * ^status = #draft * id 1..1 @@ -97,13 +97,13 @@ Description: "Family Study" * identifier 0..* * identifier ^short = "External IDs for this participant. Requires scoping." * extension contains FamilyType named family-type 0..1 -* extension[family-type] ^short = "Describes the 'type' of family study, eg, trio." +* extension[family-type] ^short = "Describes the 'type' of study family, eg, trio." * extension contains Description named description 0..1 -* extension[description] ^short = "Free text describing the family study, such as potential inheritance or details about consanguinity" +* extension[description] ^short = "Free text describing the study family, such as potential inheritance or details about consanguinity" * extension contains Consanguinity named consanguinity 0..1 -* extension[consanguinity] ^short = "Is there known or suspected consanguinity in this family study?" -* extension contains FamilyStudyFocus named family-study-focus 0..1 -* extension[family-study-focus] ^short = "What is this family study investigating? EG, a specific condition" +* extension[consanguinity] ^short = "Is there known or suspected consanguinity in this study family?" +* extension contains StudyFamilyFocus named study-family-focus 0..1 +* extension[study-family-focus] ^short = "What is this study family investigating? EG, a specific condition" // Family Role @@ -112,21 +112,21 @@ Id: SharedDataModelFamilyRole Title: "Shared Data Model for Family Role" Description: "The **Shared Data Model for Family Role**" * participant 1..1 Reference "The participant we are describing" -* familyStudy 1..1 Reference "The family study this participant is part of" +* studyFamily 1..1 Reference "The study family this participant is part of" * familyRole 0..1 code "The role this individual has in the family, specifically with respect to a proband or index participant" -Extension: FamilyStudy -Id: family-study -Title: "Family Study Reference" -Description: "Extension containing Family Study Reference" +Extension: StudyFamily +Id: study-family +Title: "Study Family Reference" +Description: "Extension containing Study Family Reference" * insert SetContext(Group) * value[x] only Reference * valueReference 1..1 -* valueReference only Reference(NcpiFamilyStudy) +* valueReference only Reference(NcpiStudyFamily) Extension: FamilyRole Id: family-role -Title: "Family Study Focus" +Title: "Study Family Focus" Description: "Extension containing Family Role" * value[x] only CodeableConcept * valueCodeableConcept ^short = "The role this individual has in the family, specifically with respect to a proband or index participant" @@ -142,8 +142,8 @@ Description: "Shared Data Model for Family Role" * member.entity 1..1 * member.entity only Reference(NcpiParticipant) * member.entity ^short = "The participant we are describing." -* extension contains FamilyStudy named family-study 0..1 -* extension[family-study] ^short = "The family study this participant is part of" +* extension contains StudyFamily named study-family 0..1 +* extension[study-family] ^short = "The study family this participant is part of" * extension contains FamilyRole named family-role 0..1 * extension[family-role] ^short = "The role this individual has in the family, specifically with respect to a proband or index participant" @@ -152,8 +152,8 @@ Description: "Shared Data Model for Family Role" Logical: CdmFamilyRelationship Id: SharedDataModelFamilyRelationship -Title: "Shared Data Model for Family Study" -Description: "The **Shared Data Model for Family Study**" +Title: "Shared Data Model for Study Family" +Description: "The **Shared Data Model for Study Family**" * subject 1..1 Reference "The participant we are describing" * target 1..1 Reference "The participant the subject has a relationship to, eg, 'Subject is Relationship to Target' or 'Subject is Mother of Target'" * relationship 1..1 code "The relationship between the subject and the target." diff --git a/input/pagecontent/StructureDefinition-ncpi-family-study-intro.md b/input/pagecontent/StructureDefinition-ncpi-study-family-intro.md similarity index 89% rename from input/pagecontent/StructureDefinition-ncpi-family-study-intro.md rename to input/pagecontent/StructureDefinition-ncpi-study-family-intro.md index ba5c6d04..64eaa903 100644 --- a/input/pagecontent/StructureDefinition-ncpi-family-study-intro.md +++ b/input/pagecontent/StructureDefinition-ncpi-study-family-intro.md @@ -1,5 +1,5 @@ #### Key Guidelines -Family Study describes a group of Participants that are related. This is not an expression of all individuals in a “family”, but a tool to identify “family members of interest” that were studied. For example, a family trio in a rare disease study does not exclude the existence of other siblings. Family Studies do not require much detail, but there are often attributes of those families that may be of use to researchers. +Study Family describes a group of Participants that are related. This is not an expression of all individuals in a “family”, but a tool to identify “family members of interest” that were studied. For example, a family trio in a rare disease study does not exclude the existence of other siblings. Family Studies do not require much detail, but there are often attributes of those families that may be of use to researchers. ##### Added Profile Restrictions In order to ensure that our resources are interoperable across studies, we have employed a number of restrictions that should make consuming Patient resources more consistent. @@ -19,5 +19,5 @@ externalID|0..*|identifier||| FamilyType|0..1|extension [FamilyType](StructureDefinition-family-type.html)||| Description|0..1|extension [Description](StructureDefinition-description.html)||| Consanguinity|0..1|extension [Consanguinity](StructureDefinition-consanguinity.html)||| -FamilyStudyFocus|0..1|extension [FamilyStudyFocus](StructureDefinition-family-study-focus.html)||| +StudyFamilyFocus|0..1|extension [StudyFamilyFocus](StructureDefinition-study-family-focus.html)||| diff --git a/input/pagecontent/StructureDefinition-ncpi-family-study-notes.md b/input/pagecontent/StructureDefinition-ncpi-study-family-notes.md similarity index 100% rename from input/pagecontent/StructureDefinition-ncpi-family-study-notes.md rename to input/pagecontent/StructureDefinition-ncpi-study-family-notes.md